summaryrefslogtreecommitdiffstats
path: root/cpukit/score/include/rtems/score/coresem.h
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2012-11-28 13:57:31 -0600
committerJoel Sherrill <joel.sherrill@oarcorp.com>2012-11-28 13:57:31 -0600
commit355ee7dbd52a1ea5fd7d8b32d31aeccd58ccb8c4 (patch)
tree9a21764eba2821fee88b7c064c2ad44477ff1cc3 /cpukit/score/include/rtems/score/coresem.h
parentscore misc: Clean up Doxygen #2 (GCI 2012) (diff)
downloadrtems-355ee7dbd52a1ea5fd7d8b32d31aeccd58ccb8c4.tar.bz2
score misc: Clean up Doxygen #3 (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/7982215
Diffstat (limited to 'cpukit/score/include/rtems/score/coresem.h')
-rw-r--r--cpukit/score/include/rtems/score/coresem.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/cpukit/score/include/rtems/score/coresem.h b/cpukit/score/include/rtems/score/coresem.h
index fc4d0baa34..c8d7deb703 100644
--- a/cpukit/score/include/rtems/score/coresem.h
+++ b/cpukit/score/include/rtems/score/coresem.h
@@ -127,6 +127,14 @@ typedef struct {
} CORE_semaphore_Control;
/**
+ * @brief Core Semaphore Initialize
+ *
+ * DESCRIPTION:
+ *
+ * This package is the implementation of the CORE Semaphore Handler.
+ * This core object utilizes standard Dijkstra counting semaphores to provide
+ * synchronization and mutual exclusion capabilities.
+ *
* This routine initializes the semaphore based on the parameters passed.
*
* @param[in] the_semaphore is the semaphore to initialize