summaryrefslogtreecommitdiffstats
path: root/cpukit/score/include/rtems/score/coresem.h
diff options
context:
space:
mode:
authorMathew Kallada <matkallada@gmail.com>2012-12-29 10:27:48 -0600
committerJennifer Averett <jennifer.averett@oarcorp.com>2012-12-29 10:27:48 -0600
commit1dbbc0c3b19c9113a2fbf4a511b4cff84dd6aa8e (patch)
tree2c0863987a7f34279aa78894e9a21185e3f7bbe2 /cpukit/score/include/rtems/score/coresem.h
parentscore: Doxygen Clean Up Task #6 (diff)
downloadrtems-1dbbc0c3b19c9113a2fbf4a511b4cff84dd6aa8e.tar.bz2
score: Doxygen Clean Up Task #1
Diffstat (limited to 'cpukit/score/include/rtems/score/coresem.h')
-rw-r--r--cpukit/score/include/rtems/score/coresem.h20
1 files changed, 11 insertions, 9 deletions
diff --git a/cpukit/score/include/rtems/score/coresem.h b/cpukit/score/include/rtems/score/coresem.h
index d7a8494c55..77a7d3e25f 100644
--- a/cpukit/score/include/rtems/score/coresem.h
+++ b/cpukit/score/include/rtems/score/coresem.h
@@ -1,6 +1,8 @@
/**
* @file rtems/score/coresem.h
*
+ * @brief Data Associated with the Counting Semaphore Handler
+ *
* This include file contains all the constants and structures associated
* with the Counting Semaphore Handler. A counting semaphore is the
* standard Dijkstra binary semaphore used to provide synchronization
@@ -90,7 +92,7 @@ typedef enum {
} CORE_semaphore_Status;
/**
- * @brief Core Semaphore Last Status
+ * @brief Core semaphore last status value.
*
* This is the last status value.
*/
@@ -127,14 +129,14 @@ typedef struct {
} CORE_semaphore_Control;
/**
- * @brief Core Semaphore Initialize
- *
+ * @brief Initialize the semaphore based on the parameters passed.
+ *
* 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
@@ -170,7 +172,7 @@ void _CORE_semaphore_Initialize(
#endif
/**
- * @brief Surrenders a Unit to a Semaphore
+ * @brief Surrender a unit to a semaphore.
*
* This routine frees a unit to the semaphore. If a task was blocked waiting
* for a unit from this semaphore, then that task will be readied and the unit
@@ -182,7 +184,7 @@ void _CORE_semaphore_Initialize(
* @param[in] api_semaphore_mp_support is the routine to invoke if the
* thread unblocked is remote
*
- * @return an indication of whether the routine succeeded or failed
+ * @retval an indication of whether the routine succeeded or failed
*/
CORE_semaphore_Status _CORE_semaphore_Surrender(
CORE_semaphore_Control *the_semaphore,
@@ -191,8 +193,8 @@ CORE_semaphore_Status _CORE_semaphore_Surrender(
);
/**
- * @brief Core Semaphore Flush
- *
+ * @brief Core semaphore flush.
+ *
* DESCRIPTION:
* This package is the implementation of the CORE Semaphore Handler.
* This core object utilizes standard Dijkstra counting semaphores to provide
@@ -223,4 +225,4 @@ void _CORE_semaphore_Flush(
/**@}*/
#endif
-/* end of include file */
+/* end of include file */ \ No newline at end of file