summaryrefslogtreecommitdiffstats
path: root/cpukit/score/include/rtems/score/prioritybitmap.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/prioritybitmap.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/prioritybitmap.h')
-rw-r--r--cpukit/score/include/rtems/score/prioritybitmap.h13
1 files changed, 9 insertions, 4 deletions
diff --git a/cpukit/score/include/rtems/score/prioritybitmap.h b/cpukit/score/include/rtems/score/prioritybitmap.h
index 4a9966cef7..280a0674fd 100644
--- a/cpukit/score/include/rtems/score/prioritybitmap.h
+++ b/cpukit/score/include/rtems/score/prioritybitmap.h
@@ -1,6 +1,8 @@
/**
* @file rtems/score/prioritybitmap.h
*
+ * @brief Manipulation Routines for the Bitmap Priority Queue Implementation
+ *
* This include file contains all thread priority manipulation routines for
* the bit map priority queue implementation.
*/
@@ -18,8 +20,11 @@
#define _RTEMS_SCORE_PRIORITYBITMAP_H
/**
- * @addtogroup ScorePriority
+ * @defgroup ScorePriority Bitmap Priority Thread Routines
*
+ * @ingroup Score
+ *
+ * @addtogroup ScorePriority
*/
/**@{*/
@@ -86,7 +91,7 @@ typedef struct {
*
* @param[in] _bit_number is the bit number for which we need a mask
*
- * @return the priority bit mask
+ * @retval the priority bit mask
*
* @note This may simply be a pass through to a CPU dependent implementation.
*/
@@ -100,7 +105,7 @@ typedef struct {
*
* @param[in] _priority is the priority for which we need the index.
*
- * @return This method returns the array index into the priority bit map.
+ * @retval This method returns the array index into the priority bit map.
*
* @note This may simply be a pass through to a CPU dependent implementation.
*/
@@ -119,4 +124,4 @@ typedef struct {
/**@}*/
#endif
-/* end of include file */
+/* end of include file */ \ No newline at end of file