summaryrefslogtreecommitdiffstats
path: root/cpukit/score/include
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@oarcorp.com>2013-01-10 13:20:34 -0600
committerJoel Sherrill <joel.sherrill@oarcorp.com>2013-01-10 17:06:47 -0600
commita15eaaf9fdba8a9311623ae44711d17701a19d30 (patch)
treeeb6f4439e820390ad8b0f8ed5a10ed6835461548 /cpukit/score/include
parentscore: Doxygen Clean Up Task #14 (diff)
downloadrtems-a15eaaf9fdba8a9311623ae44711d17701a19d30.tar.bz2
cpukit: Doxygen group fixes and many warnings addressed
The output of the modules.html is much improved. Most filesystem and POSIX API related groups are properly nested. Some formatting issues were addressed as were multiple inconsistencies.
Diffstat (limited to 'cpukit/score/include')
-rw-r--r--cpukit/score/include/rtems/score/copyrt.h4
-rw-r--r--cpukit/score/include/rtems/score/prioritybitmap.h6
-rw-r--r--cpukit/score/include/rtems/score/scheduler.h2
-rw-r--r--cpukit/score/include/rtems/score/schedulercbs.h8
-rw-r--r--cpukit/score/include/rtems/score/scheduleredf.h9
-rw-r--r--cpukit/score/include/rtems/score/schedulerpriority.h8
-rw-r--r--cpukit/score/include/rtems/score/schedulersimple.h10
-rw-r--r--cpukit/score/include/rtems/score/schedulersimplesmp.h8
-rw-r--r--cpukit/score/include/rtems/score/smp.h6
-rw-r--r--cpukit/score/include/rtems/score/states.h7
-rw-r--r--cpukit/score/include/rtems/score/timestamp.h4
-rw-r--r--cpukit/score/include/rtems/score/timestamp64.h4
12 files changed, 31 insertions, 45 deletions
diff --git a/cpukit/score/include/rtems/score/copyrt.h b/cpukit/score/include/rtems/score/copyrt.h
index 58c1809af8..cc66f5cf52 100644
--- a/cpukit/score/include/rtems/score/copyrt.h
+++ b/cpukit/score/include/rtems/score/copyrt.h
@@ -20,7 +20,7 @@
#define _RTEMS_SCORE_COPYRT_H
/**
- * @defgroup SuperCore RTEMS Copyright Notice
+ * @defgroup SuperCoreCopyright RTEMS Copyright Notice
*
* @ingroup Score
*/
@@ -47,4 +47,4 @@ extern const char _Copyright_Notice[];
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/prioritybitmap.h b/cpukit/score/include/rtems/score/prioritybitmap.h
index 280a0674fd..8e8f21ce34 100644
--- a/cpukit/score/include/rtems/score/prioritybitmap.h
+++ b/cpukit/score/include/rtems/score/prioritybitmap.h
@@ -20,11 +20,9 @@
#define _RTEMS_SCORE_PRIORITYBITMAP_H
/**
- * @defgroup ScorePriority Bitmap Priority Thread Routines
+ * @defgroup ScorePriorityBitmap Bitmap Priority Thread Routines
*
* @ingroup Score
- *
- * @addtogroup ScorePriority
*/
/**@{*/
@@ -124,4 +122,4 @@ typedef struct {
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/scheduler.h b/cpukit/score/include/rtems/score/scheduler.h
index 91a6bbdff4..5c35a36de1 100644
--- a/cpukit/score/include/rtems/score/scheduler.h
+++ b/cpukit/score/include/rtems/score/scheduler.h
@@ -150,4 +150,4 @@ void _Scheduler_Handler_initialization( void );
#endif
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/schedulercbs.h b/cpukit/score/include/rtems/score/schedulercbs.h
index 96fd6fac3f..53452e044a 100644
--- a/cpukit/score/include/rtems/score/schedulercbs.h
+++ b/cpukit/score/include/rtems/score/schedulercbs.h
@@ -33,11 +33,9 @@ extern "C" {
#endif
/**
- * @defgroup ScoreScheduler CBS Scheduler
+ * @defgroup ScoreSchedulerCBS CBS Scheduler
*
- * @ingroup Score
- *
- * @addtogroup ScoreScheduler
+ * @ingroup ScoreScheduler
*/
/**@{*/
@@ -346,4 +344,4 @@ void *_Scheduler_CBS_Allocate(
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/scheduleredf.h b/cpukit/score/include/rtems/score/scheduleredf.h
index 5c5c2c4f97..24f9a1ac32 100644
--- a/cpukit/score/include/rtems/score/scheduleredf.h
+++ b/cpukit/score/include/rtems/score/scheduleredf.h
@@ -29,12 +29,9 @@ extern "C" {
#endif
/**
- * @defgroup ScoreScheduler
- *
- * @ingroup Score
- *
- * @addtogroup ScoreScheduler
+ * @defgroup ScoreSchedulerEDF EDF Scheduler
*
+ * @ingroup ScoreScheduler
*/
/**@{*/
@@ -270,4 +267,4 @@ void _Scheduler_EDF_Release_job (
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/schedulerpriority.h b/cpukit/score/include/rtems/score/schedulerpriority.h
index 9c2dc8cbbb..f97bb7f075 100644
--- a/cpukit/score/include/rtems/score/schedulerpriority.h
+++ b/cpukit/score/include/rtems/score/schedulerpriority.h
@@ -28,11 +28,9 @@ extern "C" {
#endif
/**
- * @defgroup ScoreScheduler Priority-based Scheduler
+ * @defgroup ScoreSchedulerDPS Deterministic Priority-based Scheduler
*
- * @ingroup Score
- *
- * @addtogroup ScoreScheduler
+ * @ingroup ScoreScheduler
*/
/**@{*/
@@ -254,4 +252,4 @@ extern Priority_bit_map_Control _Priority_Bit_map[16] CPU_STRUCTURE_ALIGNMENT;
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/schedulersimple.h b/cpukit/score/include/rtems/score/schedulersimple.h
index f350d533ad..df52a586be 100644
--- a/cpukit/score/include/rtems/score/schedulersimple.h
+++ b/cpukit/score/include/rtems/score/schedulersimple.h
@@ -19,11 +19,9 @@
#define _RTEMS_SCORE_SCHEDULERSIMPLE_H
/**
- * @defgroup ScoreScheduler
+ * @defgroup ScoreSchedulerSimple Simple Priority Scheduler
*
- * @ingroup Score
- *
- * @addtogroup ScoreScheduler
+ * @ingroup ScoreScheduler
*/
/**@{*/
@@ -166,7 +164,7 @@ void *_Scheduler_simple_Allocate(
);
/**
- * @breif Stub for simple schedule update.
+ * @brief Stub for simple schedule update.
*
* This routine does nothing, and is used as a stub for Schedule update
* The overhead of a function call will still be imposed.
@@ -225,4 +223,4 @@ void _Scheduler_simple_Ready_queue_enqueue_first(
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/schedulersimplesmp.h b/cpukit/score/include/rtems/score/schedulersimplesmp.h
index 86c7d9a900..63213c6b2a 100644
--- a/cpukit/score/include/rtems/score/schedulersimplesmp.h
+++ b/cpukit/score/include/rtems/score/schedulersimplesmp.h
@@ -23,11 +23,9 @@
#define _RTEMS_SCORE_SCHEDULERSIMPLE_SMP_H
/**
- * @defgroup ScoreScheduler
+ * @defgroup ScoreSchedulerSMP Simple SMP Scheduler
*
- * @ingroup Score
- *
- * @addtogroup ScoreScheduler
+ * @ingroup ScoreScheduler
*
* The Simple SMP Scheduler attempts to faithfully implement the
* behaviour of the Deterministic Priority Scheduler while spreading
@@ -120,4 +118,4 @@ void _Scheduler_simple_smp_Tick( void );
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/smp.h b/cpukit/score/include/rtems/score/smp.h
index b3d964b8d2..f4bf72edd9 100644
--- a/cpukit/score/include/rtems/score/smp.h
+++ b/cpukit/score/include/rtems/score/smp.h
@@ -23,7 +23,7 @@
#include <rtems/score/percpu.h>
/**
- * @defgroup SuperCore SMP Support
+ * @defgroup SuperCoreSMP SMP Support
*
* @ingroup Score
*
@@ -105,7 +105,7 @@ void _SMP_Request_other_cores_to_perform_first_context_switch(void);
void _SMP_Request_other_cores_to_dispatch(void);
/**
- * @Brief Request other cores to shutdown.
+ * @brief Request other cores to shutdown.
*
* Send message to other cores requesting them to shutdown.
*/
@@ -121,4 +121,4 @@ void _SMP_Request_other_cores_to_shutdown(void);
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/states.h b/cpukit/score/include/rtems/score/states.h
index 9732875228..9fab5d4748 100644
--- a/cpukit/score/include/rtems/score/states.h
+++ b/cpukit/score/include/rtems/score/states.h
@@ -3,7 +3,7 @@
*
* @brief Thread Execution State Information
*
- * This include file contains thread execution state information.
+ * This include file defines thread execution state information.
*/
/*
@@ -19,8 +19,7 @@
#define _RTEMS_SCORE_STATES_H
/**
- * @defgroup Encapsulates functionality which relates to the management of
- * the state bitmap associated with each thread.
+ * @defgroup ScoreStates SuperCore Thread States
*
* @ingroup Score
*
@@ -130,4 +129,4 @@ typedef uint32_t States_Control;
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/timestamp.h b/cpukit/score/include/rtems/score/timestamp.h
index fb297da06d..638ae7bf52 100644
--- a/cpukit/score/include/rtems/score/timestamp.h
+++ b/cpukit/score/include/rtems/score/timestamp.h
@@ -19,7 +19,7 @@
#define _RTEMS_SCORE_TIMESTAMP_H
/**
- * @defgroup SuperCore Timestamp
+ * @defgroup SuperCoreTimeStamp Score Timestamp
*
* @ingroup Score
*
@@ -370,4 +370,4 @@ extern "C" {
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */
diff --git a/cpukit/score/include/rtems/score/timestamp64.h b/cpukit/score/include/rtems/score/timestamp64.h
index 65da8f3497..306ee35fee 100644
--- a/cpukit/score/include/rtems/score/timestamp64.h
+++ b/cpukit/score/include/rtems/score/timestamp64.h
@@ -20,7 +20,7 @@
#define _RTEMS_SCORE_TIMESTAMP64_H
/**
- * @defgroup SuperCore Timestamp64
+ * @defgroup SuperCoreTimestamp64 SuperCore Sixty-Four Bit Timestamps
*
* @ingroup Score
*
@@ -428,4 +428,4 @@ static inline void _Timestamp64_implementation_To_timeval(
/**@}*/
#endif
-/* end of include file */ \ No newline at end of file
+/* end of include file */