summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/include/rtems')
-rw-r--r--cpukit/include/rtems/chain.h12
-rw-r--r--cpukit/include/rtems/counter.h4
-rw-r--r--cpukit/include/rtems/extension.h10
-rw-r--r--cpukit/include/rtems/ioimpl.h17
-rw-r--r--cpukit/include/rtems/profiling.h6
-rw-r--r--cpukit/include/rtems/rbheap.h11
-rw-r--r--cpukit/include/rtems/rbtree.h14
-rw-r--r--cpukit/include/rtems/timecounter.h9
-rw-r--r--cpukit/include/rtems/version.h7
9 files changed, 58 insertions, 32 deletions
diff --git a/cpukit/include/rtems/chain.h b/cpukit/include/rtems/chain.h
index 25ea0b23b7..03177834a9 100644
--- a/cpukit/include/rtems/chain.h
+++ b/cpukit/include/rtems/chain.h
@@ -1,7 +1,9 @@
/**
* @file
*
- * @brief Chain API
+ * @ingroup RTEMSAPIClassicChains
+ *
+ * @brief This header file provides the Chains API.
*/
/*
@@ -26,13 +28,15 @@ extern "C" {
#endif
/**
- * @defgroup ClassicChains Chains
+ * @defgroup RTEMSAPIClassicChains Chains
*
* @ingroup RTEMSAPIClassic
*
- * @brief Chain API
+ * @brief The chain container provides data structures and directives to manage
+ * user-defined data structures in doubly-linked lists.
+ *
+ * @{
*/
-/**@{**/
typedef Chain_Node rtems_chain_node;
diff --git a/cpukit/include/rtems/counter.h b/cpukit/include/rtems/counter.h
index caf0491d9c..5bf7736e4a 100644
--- a/cpukit/include/rtems/counter.h
+++ b/cpukit/include/rtems/counter.h
@@ -30,9 +30,9 @@ extern "C" {
#endif /* __cplusplus */
/**
- * @defgroup ClassicCounter Free-Running Counter and Busy Wait Delay
+ * @defgroup RTEMSAPICounter Free-Running Counter and Busy Wait Delay
*
- * @ingroup RTEMSAPIClassic
+ * @ingroup RTEMSAPI
*
* @brief Free-running counter and busy wait delay functions.
*
diff --git a/cpukit/include/rtems/extension.h b/cpukit/include/rtems/extension.h
index 59d4839bf4..6f97ebe24c 100644
--- a/cpukit/include/rtems/extension.h
+++ b/cpukit/include/rtems/extension.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup ClassicUserExtensions
+ * @ingroup RTEMSImplClassicUserExt
*
* @brief User Extensions API.
*/
@@ -27,7 +27,7 @@ extern "C" {
#endif
/**
- * @defgroup ClassicUserExtensions User Extensions
+ * @defgroup RTEMSAPIClassicUserExt User Extensions Manager
*
* @ingroup RTEMSAPIClassic
*
@@ -35,7 +35,7 @@ extern "C" {
* augment the executive by allowing them to supply extension routines which
* are invoked at critical system events.
*
- * @section ClassicUserExtensionsSets Extension Sets
+ * @section RTEMSAPIClassicUserExtSets Extension Sets
*
* An @ref User_extensions_Table "extension set" is defined as a set of
* routines which are invoked at each of the critical system events at which
@@ -75,7 +75,7 @@ extern "C" {
* Extension switches do not effect the context switch overhead if no switch
* handler is installed.
*
- * @section ClassicUserExtensionsTCB Task Control Block Area
+ * @section RTEMSAPIClassicUserExtTCB Task Control Block Area
*
* RTEMS provides for a pointer to a user-defined data area for each extension
* set to be linked to each task's control block (TCB). This area is only
@@ -114,7 +114,7 @@ extern "C" {
* buffers and use the partition manager's allocation and deallocation
* directives to obtain and release the extension buffers.
*
- * @section ClassicUserExtensionsOrder Order of Invokation
+ * @section RTEMSAPIClassicUserExtOrder Order of Invokation
*
* When one of the critical system events occur, the user extensions are
* invoked in either @a forward or @a reverse order. Forward order indicates
diff --git a/cpukit/include/rtems/ioimpl.h b/cpukit/include/rtems/ioimpl.h
index 5c4a82eea6..df2cc8d43e 100644
--- a/cpukit/include/rtems/ioimpl.h
+++ b/cpukit/include/rtems/ioimpl.h
@@ -1,7 +1,10 @@
/**
* @file
*
- * @brief Classic Input/Output Manager Implementation API
+ * @ingroup RTEMSImplClassicIO
+ *
+ * @brief This header file provides interfaces used by the I/O Manager
+ * implementation.
*/
/*
@@ -23,6 +26,16 @@
extern "C" {
#endif /* __cplusplus */
+/**
+ * @defgroup RTEMSImplClassicIO I/O Manager
+ *
+ * @ingroup RTEMSImplClassic
+ *
+ * @brief This group contains the I/O Manager implementation.
+ *
+ * @{
+ */
+
extern const size_t _IO_Number_of_drivers;
extern rtems_driver_address_table _IO_Driver_address_table[];
@@ -58,6 +71,8 @@ RTEMS_INLINE_ROUTINE void _IO_Driver_registration_release(
);
}
+/** @} */
+
#ifdef __cplusplus
}
#endif /* __cplusplus */
diff --git a/cpukit/include/rtems/profiling.h b/cpukit/include/rtems/profiling.h
index 3bad1eda49..9b4b70489c 100644
--- a/cpukit/include/rtems/profiling.h
+++ b/cpukit/include/rtems/profiling.h
@@ -1,9 +1,9 @@
/**
* @file
*
- * @ingroup Profiling
+ * @ingroup RTEMSAPIProfiling
*
- * @brief Profiling API
+ * @brief This header file provides the Profiling Support API.
*/
/*
@@ -32,7 +32,7 @@ extern "C" {
#endif /* __cplusplus */
/**
- * @defgroup Profiling Profiling Support
+ * @defgroup RTEMSAPIProfiling Profiling Support
*
* @ingroup RTEMSAPI
*
diff --git a/cpukit/include/rtems/rbheap.h b/cpukit/include/rtems/rbheap.h
index d772c1a284..0db72ebf93 100644
--- a/cpukit/include/rtems/rbheap.h
+++ b/cpukit/include/rtems/rbheap.h
@@ -1,7 +1,9 @@
/**
* @file
*
- * @brief Red-Black Tree Heap API
+ * @ingroup RTEMSAPIRBHeap
+ *
+ * @brief This header file provides the Red-Black Tree Heap API.
*/
/*
@@ -30,11 +32,12 @@ extern "C" {
#endif
/**
- * @defgroup RBHeap Red-Black Tree Heap
+ * @defgroup RTEMSAPIRBHeap Red-Black Tree Heap
*
- * @ingroup RTEMSAPIClassic
+ * @ingroup RTEMSAPI
*
- * @brief Red-Black Tree Heap API.
+ * @brief The red-black tree heap provides a memory allocator using a red-black
+ * tree to maintain blocks of memory.
*
* The red-black tree heap provides a memory allocator suitable to implement
* the malloc() and free() interface. It uses a first-fit allocation strategy.
diff --git a/cpukit/include/rtems/rbtree.h b/cpukit/include/rtems/rbtree.h
index 6a45037ac3..be3f08c7f1 100644
--- a/cpukit/include/rtems/rbtree.h
+++ b/cpukit/include/rtems/rbtree.h
@@ -1,12 +1,9 @@
/**
* @file
*
- * @brief Constants and Structures Associated with the RBTree API in RTEMS
- *
- * This include file contains all the constants and structures associated
- * with the RBTree API in RTEMS. The rbtree is a Red Black Tree that
- * is part of the Super Core. This is the published interface to that
- * code.
+ * @ingroup RTEMSAPIClassicRBTrees
+ *
+ * @brief This header file provides the Red-Black Trees API.
*/
/*
@@ -27,11 +24,12 @@ extern "C" {
#endif
/**
- * @defgroup ClassicRBTrees Red-Black Trees
+ * @defgroup RTEMSAPIRBTrees Red-Black Trees
*
* @ingroup RTEMSAPIClassic
*
- * @brief A Red-Black Tree container.
+ * @brief The red-black tree container provides data structures and directives
+ * to manage user-defined data structures in red-black trees.
*
* The red-black tree container offers no internal protection against
* concurrent access. The user must ensure that at most one thread at once can
diff --git a/cpukit/include/rtems/timecounter.h b/cpukit/include/rtems/timecounter.h
index 8ff18c2da3..d5025d8b1a 100644
--- a/cpukit/include/rtems/timecounter.h
+++ b/cpukit/include/rtems/timecounter.h
@@ -1,9 +1,9 @@
/**
* @file
*
- * @ingroup SAPITimecounter
+ * @ingroup RTEMSAPIClassicTimecounter
*
- * @brief Timecounter API
+ * @brief This header file provides the Timecounter Support API.
*/
/*
@@ -31,10 +31,13 @@ extern "C" {
#endif /* __cplusplus */
/**
- * @defgroup SAPITimecounter Timecounter Support
+ * @defgroup RTEMSAPIClassicTimecounter Timecounter Support
*
* @ingroup RTEMSAPIClassic
*
+ * @brief The timecounter support provides directives to implement clock device
+ * drivers.
+ *
* @{
*/
diff --git a/cpukit/include/rtems/version.h b/cpukit/include/rtems/version.h
index a8aff732f3..87d5e1492c 100644
--- a/cpukit/include/rtems/version.h
+++ b/cpukit/include/rtems/version.h
@@ -1,7 +1,9 @@
/**
* @file
*
- * @brief Version API.
+ * @ingroup RTEMSAPIClassicVersion
+ *
+ * @brief This header file provides the Version API.
*/
/*
@@ -29,8 +31,9 @@ extern "C" {
*
* @brief The Version API provides functions to return the version or parts of
* the version of RTEMS you are using.
+ *
+ * @{
*/
-/**@{**/
/**
* @brief Returns the version string.