summaryrefslogtreecommitdiffstats
path: root/cpukit/score/src/corespinlock.c
diff options
context:
space:
mode:
authorChristopher Kerl <zargyyoyo@gmail.com>2012-11-28 13:31:53 -0600
committerJoel Sherrill <joel.sherrill@oarcorp.com>2012-11-28 13:31:53 -0600
commitd4d7899bb2730dc77331db202a2473818a7ea351 (patch)
treefc3204f40c34ba4da1e6db310dbdf82c81c8c6a7 /cpukit/score/src/corespinlock.c
parentscore misc: Clean up Doxygen (GCI 2012) (diff)
downloadrtems-d4d7899bb2730dc77331db202a2473818a7ea351.tar.bz2
score misc: Clean up Doxygen #2 (GCI 2012)
This patch is a task from GCI 2012 which improves the Doxygen comments in the RTEMS source. http://www.google-melange.com/gci/task/view/google/gci2012/7986213
Diffstat (limited to 'cpukit/score/src/corespinlock.c')
-rw-r--r--cpukit/score/src/corespinlock.c25
1 files changed, 7 insertions, 18 deletions
diff --git a/cpukit/score/src/corespinlock.c b/cpukit/score/src/corespinlock.c
index e90792d1e9..bc7084e468 100644
--- a/cpukit/score/src/corespinlock.c
+++ b/cpukit/score/src/corespinlock.c
@@ -1,10 +1,12 @@
-/*
- * SuperCore Spinlock Handler
- *
- * DESCRIPTION:
+/**
+ * @file
*
- * This package is part of the implementation of the SuperCore Spinlock Handler.
+ * @brief Initialize a Spinlock
*
+ * @ingroup ScoreSpinlock
+ */
+
+/*
* COPYRIGHT (c) 1989-2006.
* On-Line Applications Research Corporation (OAR).
*
@@ -23,19 +25,6 @@
#include <rtems/score/thread.h>
#include <rtems/score/threadq.h>
-/*
- * _CORE_spinlock_Initialize
- *
- * This function initialize a spinlock and sets the initial value based
- * on the given count.
- *
- * Input parameters:
- * the_spinlock - the spinlock control block to initialize
- * the_spinlock_attributes - the attributes specified at create time
- *
- * Output parameters: NONE
- */
-
void _CORE_spinlock_Initialize(
CORE_spinlock_Control *the_spinlock,
CORE_spinlock_Attributes *the_spinlock_attributes