diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-11-25 16:42:08 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-12-02 07:45:53 +0100 |
commit | e07088d9ba894d8d1fd4dba8b2ff03ccffebba05 (patch) | |
tree | df9abb0f21b854372ed3a2374f1d5b02d85623ee /cpukit/include/rtems/rtems | |
parent | rtems: Add <rtems/rtems/clockimpl.h> (diff) | |
download | rtems-e07088d9ba894d8d1fd4dba8b2ff03ccffebba05.tar.bz2 |
rtems: Canonicalize implementation Doxygen groups
Rename Classic API top-level group from Classic to RTEMSImplClassic.
Use RTEMSImplClassic as a prefix for the subgroups. Change the group
names to be in line with the API group names. Use common phrases for
the group brief descriptions.
Update #3706.
Diffstat (limited to 'cpukit/include/rtems/rtems')
35 files changed, 160 insertions, 94 deletions
diff --git a/cpukit/include/rtems/rtems/asrdata.h b/cpukit/include/rtems/rtems/asrdata.h index 70b2416257..2ff1ac87c0 100644 --- a/cpukit/include/rtems/rtems/asrdata.h +++ b/cpukit/include/rtems/rtems/asrdata.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicASRImpl + * @ingroup RTEMSImplClassicASR * * @brief Classic ASR Data Structures */ @@ -24,7 +24,7 @@ extern "C" { #endif /** - * @addtogroup ClassicASRImpl + * @addtogroup RTEMSImplClassicASR * * @{ */ diff --git a/cpukit/include/rtems/rtems/asrimpl.h b/cpukit/include/rtems/rtems/asrimpl.h index e940cbbf5f..f007457fe5 100644 --- a/cpukit/include/rtems/rtems/asrimpl.h +++ b/cpukit/include/rtems/rtems/asrimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicASRImpl + * @ingroup RTEMSImplClassicASR * * @brief Classic ASR Implementation */ @@ -26,10 +26,13 @@ extern "C" { #endif /** - * @defgroup ClassicASRImpl Classic ASR Implementation + * @defgroup RTEMSImplClassicASR Asynchronous Signal Routine (ASR) * * @ingroup RTEMSImplClassic * + * @brief This group contains the implementation to support asynchronous signal + * routines. + * * @{ */ diff --git a/cpukit/include/rtems/rtems/attrimpl.h b/cpukit/include/rtems/rtems/attrimpl.h index feb4f1821a..3b19c67387 100644 --- a/cpukit/include/rtems/rtems/attrimpl.h +++ b/cpukit/include/rtems/rtems/attrimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicAttributesImpl + * @ingroup RTEMSImplClassicAttr * * @brief Classic Attributes Implementation */ @@ -26,10 +26,13 @@ extern "C" { #endif /** - * @defgroup ClassicAttributesImpl Classic Attributes Implementation + * @defgroup RTEMSImplClassicAttr Directive Attributes * * @ingroup RTEMSImplClassic * + * @brief This group contains the implementation to support directive + * attributes. + * * @{ */ diff --git a/cpukit/include/rtems/rtems/barrierdata.h b/cpukit/include/rtems/rtems/barrierdata.h index baf6b1468f..256afddf30 100644 --- a/cpukit/include/rtems/rtems/barrierdata.h +++ b/cpukit/include/rtems/rtems/barrierdata.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicBarrierImpl + * @ingroup RTEMSImplClassicBarrier * * @brief Classic Barrier Manager Data Structures */ @@ -27,7 +27,7 @@ extern "C" { #endif /** - * @addtogroup ClassicBarrierImpl + * @addtogroup RTEMSImplClassicBarrier * * @{ */ diff --git a/cpukit/include/rtems/rtems/barrierimpl.h b/cpukit/include/rtems/rtems/barrierimpl.h index fbb4dea507..0cee8e4d74 100644 --- a/cpukit/include/rtems/rtems/barrierimpl.h +++ b/cpukit/include/rtems/rtems/barrierimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicBarrierImpl + * @ingroup RTEMSImplClassicBarrier * * @brief Classic Barrier Manager Implementation */ @@ -27,11 +27,13 @@ extern "C" { #endif /** - * @defgroup ClassicBarrierImpl Classic Barrier Implementation + * @defgroup RTEMSImplClassicBarrier Barrier Manager * - * @ingroup RTEMSImplClassic + * @ingroup RTEMSImplClassic * - * @{ + * @brief This group contains the Barrier Manager implementation. + * + * @{ */ /** diff --git a/cpukit/include/rtems/rtems/dpmemdata.h b/cpukit/include/rtems/rtems/dpmemdata.h index 3727297482..ce4cf2dbf6 100644 --- a/cpukit/include/rtems/rtems/dpmemdata.h +++ b/cpukit/include/rtems/rtems/dpmemdata.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicDPMEMImpl + * @ingroup RTEMSImplClassicDPMem * * @brief Classic Dual Ported Memory Manager Data Structures */ @@ -25,7 +25,7 @@ extern "C" { #endif /** - * @addtogroup ClassicDPMEMImpl + * @addtogroup RTEMSImplClassicDPMem * * @{ */ diff --git a/cpukit/include/rtems/rtems/dpmemimpl.h b/cpukit/include/rtems/rtems/dpmemimpl.h index ce98b3c5ec..54324d6016 100644 --- a/cpukit/include/rtems/rtems/dpmemimpl.h +++ b/cpukit/include/rtems/rtems/dpmemimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicDPMEMImpl + * @ingroup RTEMSImplClassicDPMem * * @brief Dual Ported Memory Manager Implementation */ @@ -25,10 +25,12 @@ extern "C" { #endif /** - * @defgroup ClassicDPMEMImpl Dual Ported Memory Manager Implementation + * @defgroup RTEMSImplClassicDPMem Dual-Ported Memory Manager * * @ingroup RTEMSImplClassic * + * @brief This group contains the Dual-Ported Memory Manager implementation. + * * @{ */ diff --git a/cpukit/include/rtems/rtems/eventdata.h b/cpukit/include/rtems/rtems/eventdata.h index 23f0a1bf9e..650c3d544a 100644 --- a/cpukit/include/rtems/rtems/eventdata.h +++ b/cpukit/include/rtems/rtems/eventdata.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicEventImpl + * @ingroup RTEMSImplClassicEvent * * @brief This header file provides the API used by the Application * Configuration to define the configured Thread Control Block (TCB). @@ -25,7 +25,7 @@ extern "C" { #endif /** - * @addtogroup ClassicEventImpl + * @addtogroup RTEMSImplClassicEvent * * @{ */ diff --git a/cpukit/include/rtems/rtems/eventimpl.h b/cpukit/include/rtems/rtems/eventimpl.h index 4635d76437..9e4f5cfa74 100644 --- a/cpukit/include/rtems/rtems/eventimpl.h +++ b/cpukit/include/rtems/rtems/eventimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicEventImpl + * @ingroup RTEMSImplClassicEvent * * @brief This header file provides interfaces used by the event implementation. */ @@ -25,10 +25,12 @@ extern "C" { #endif /** - * @defgroup ClassicEventImpl Event Implementation + * @defgroup RTEMSImplClassicEvent Event Manager * * @ingroup RTEMSImplClassic * + * @brief This group contains the Event Manager implementation. + * * @{ */ diff --git a/cpukit/include/rtems/rtems/eventmp.h b/cpukit/include/rtems/rtems/eventmp.h index f9fb1e9364..acf1cf8eb8 100644 --- a/cpukit/include/rtems/rtems/eventmp.h +++ b/cpukit/include/rtems/rtems/eventmp.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicEventMP + * @ingroup RTEMSImplClassicEventMP * * This include file contains all the constants and structures associated * with the Multiprocessing Support in the Event Manager. @@ -29,14 +29,18 @@ extern "C" { #endif /** - * @defgroup ClassicEventMP Event MP Support + * @defgroup RTEMSImplClassicEventMP Event Manager Multiprocessing (MP) Support * - * @ingroup ClassicMP + * @ingroup RTEMSImplClassicEvent * - * This encapsulates functionality related to the transparent multiprocessing - * support within the Classic API Event Manager. + * @brief This group contains the implementation to support the Event Manager + * in multiprocessing (MP) configurations. + * + * This encapsulates functionality related to the transparent multiprocessing + * support within the Classic API Event Manager. + * + * @{ */ -/**@{*/ /* * @brief Event_MP_Send_process_packet diff --git a/cpukit/include/rtems/rtems/messagedata.h b/cpukit/include/rtems/rtems/messagedata.h index 8c72fba078..83c3fcae87 100644 --- a/cpukit/include/rtems/rtems/messagedata.h +++ b/cpukit/include/rtems/rtems/messagedata.h @@ -26,7 +26,7 @@ extern "C" { #endif /** - * @addtogroup ClassicMessageQueueImpl + * @addtogroup RTEMSImplClassicMessage * * @{ */ diff --git a/cpukit/include/rtems/rtems/messageimpl.h b/cpukit/include/rtems/rtems/messageimpl.h index a3a38423d1..063a51e558 100644 --- a/cpukit/include/rtems/rtems/messageimpl.h +++ b/cpukit/include/rtems/rtems/messageimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicMessageQueueImpl + * @ingroup RTEMSImplClassicMessage * * @brief Classic Message Queue Manager Implementation */ @@ -26,11 +26,13 @@ extern "C" { #endif /** - * @defgroup ClassicMessageQueueImpl Classic Message Queue Implementation + * @defgroup RTEMSImplClassicMessage Message Manager * - * @ingroup RTEMSImplClassic + * @ingroup RTEMSImplClassic * - * @{ + * @brief This group contains the Message Manager implementation. + * + * @{ */ /** diff --git a/cpukit/include/rtems/rtems/modesimpl.h b/cpukit/include/rtems/rtems/modesimpl.h index e41c4bc93c..43e3fcb4d7 100644 --- a/cpukit/include/rtems/rtems/modesimpl.h +++ b/cpukit/include/rtems/rtems/modesimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicModesImpl + * @ingroup RTEMSImplClassicModes * * @brief Classic Modes Implementation */ @@ -25,10 +25,12 @@ extern "C" { #endif /** - * @defgroup ClassicModesImpl Classic Modes Implementation + * @defgroup RTEMSImplClassicModes Task Modes * * @ingroup RTEMSImplClassic * + * @brief This group contains the implementation to support task modes. + * * @{ */ diff --git a/cpukit/include/rtems/rtems/msgmp.h b/cpukit/include/rtems/rtems/msgmp.h index 8638e9748e..3b62224e03 100644 --- a/cpukit/include/rtems/rtems/msgmp.h +++ b/cpukit/include/rtems/rtems/msgmp.h @@ -1,6 +1,8 @@ /** * @file * + * @ingroup RTEMSImplClassicMessageMP + * * @brief Message Manager MP Support * * This include file contains all the constants and structures associated @@ -29,14 +31,16 @@ extern "C" { #endif /** - * @defgroup ClassicMsgMP Message Queue MP Support + * @defgroup RTEMSImplClassicMessageMP \ + * Message Manager Multiprocessing (MP) Support + * + * @ingroup RTEMSImplClassicMessage * - * @ingroup ClassicMP + * @brief This group contains the implementation to support the Message Manager + * in multiprocessing (MP) configurations. * - * This encapsulates functionality related to the transparent multiprocessing - * support within the Classic API Message Queue Manager. + * @{ */ -/*{*/ /** * The following enumerated type defines the list of diff --git a/cpukit/include/rtems/rtems/objectimpl.h b/cpukit/include/rtems/rtems/objectimpl.h index 11b6df93ae..ada2a5a4cb 100644 --- a/cpukit/include/rtems/rtems/objectimpl.h +++ b/cpukit/include/rtems/rtems/objectimpl.h @@ -3,7 +3,7 @@ /** * @file * - * @ingroup ClassicObjectImpl + * @ingroup RTEMSImplClassicObject * * @brief Implementation Interfaces for Classic Objects */ @@ -44,10 +44,12 @@ extern "C" { #endif /** - * @defgroup ClassicObjectImpl Classic Object Implementation + * @defgroup RTEMSImplClassicObject Object Services * * @ingroup RTEMSImplClassic * + * @brief This group contains the Object Services implementation. + * * @{ */ diff --git a/cpukit/include/rtems/rtems/optionsimpl.h b/cpukit/include/rtems/rtems/optionsimpl.h index 4d5a877429..3f08978515 100644 --- a/cpukit/include/rtems/rtems/optionsimpl.h +++ b/cpukit/include/rtems/rtems/optionsimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicOptionsImpl + * @ingroup RTEMSImplClassicOptions * * @brief Classic Options Implementation */ @@ -24,10 +24,12 @@ extern "C" { #endif /** - * @defgroup ClassicOptionsImpl Classic Options Implementation + * @defgroup RTEMSImplClassicOptions Directive Options * * @ingroup RTEMSImplClassic * + * @brief This group contains the implementation to support directive options. + * * @{ */ diff --git a/cpukit/include/rtems/rtems/partdata.h b/cpukit/include/rtems/rtems/partdata.h index 32289cd378..59daf5f002 100644 --- a/cpukit/include/rtems/rtems/partdata.h +++ b/cpukit/include/rtems/rtems/partdata.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicPartImpl + * @ingroup RTEMSImplClassicPartition * * @brief This header file provides the API used by the Application * Configuration to define the Partition Manager information. @@ -27,7 +27,7 @@ extern "C" { #endif /** - * @addtogroup ClassicPartImpl + * @addtogroup RTEMSImplClassicPartition * * @{ */ diff --git a/cpukit/include/rtems/rtems/partimpl.h b/cpukit/include/rtems/rtems/partimpl.h index e2325bf8b5..3e2b1e759e 100644 --- a/cpukit/include/rtems/rtems/partimpl.h +++ b/cpukit/include/rtems/rtems/partimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicPartImpl + * @ingroup RTEMSImplClassicPartition * * @brief This header file provides interfaces used by the Partition Manager * implementation. @@ -26,10 +26,12 @@ extern "C" { #endif /** - * @defgroup ClassicPartImpl Partition Manager Implementation + * @defgroup RTEMSImplClassicPartition Partition Manager * * @ingroup RTEMSImplClassic * + * @brief This group contains the Partition Manager implementation. + * * @{ */ diff --git a/cpukit/include/rtems/rtems/partmp.h b/cpukit/include/rtems/rtems/partmp.h index bd78d4243b..5e2ed77285 100644 --- a/cpukit/include/rtems/rtems/partmp.h +++ b/cpukit/include/rtems/rtems/partmp.h @@ -1,6 +1,8 @@ /** * @file * + * @ingroup RTEMSImplClassicPartitionMP + * * @brief MP Support in Partition Manager * * This include file contains all the constants and structures associated @@ -29,14 +31,16 @@ extern "C" { #endif /** - * @defgroup ClassicPartMP Partition MP Support + * @defgroup RTEMSImplClassicPartitionMP \ + * Partition Manager Multiprocessing (MP) Support + * + * @ingroup RTEMSImplClassicPartition * - * @ingroup ClassicMP + * @brief This group contains the implementation to support the Partition Manager + * in multiprocessing (MP) configurations. * - * This encapsulates functionality related to the transparent multiprocessing - * support within the Classic API Partition Manager. + * @{ */ -/*{*/ /** * The following enumerated type defines the list of diff --git a/cpukit/include/rtems/rtems/ratemondata.h b/cpukit/include/rtems/rtems/ratemondata.h index 0e4415237b..3fd59e8986 100644 --- a/cpukit/include/rtems/rtems/ratemondata.h +++ b/cpukit/include/rtems/rtems/ratemondata.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicRateMonImpl + * @ingroup RTEMSImplClassicRateMonotonic * * @brief Classic Rate Monotonic Scheduler Data Structures */ @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @addtogroup ClassicRateMonImpl + * @addtogroup RTEMSImplClassicRateMonotonic * * @{ */ diff --git a/cpukit/include/rtems/rtems/ratemonimpl.h b/cpukit/include/rtems/rtems/ratemonimpl.h index 5e51afdc41..998fa386bf 100644 --- a/cpukit/include/rtems/rtems/ratemonimpl.h +++ b/cpukit/include/rtems/rtems/ratemonimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicRateMonImpl + * @ingroup RTEMSImplClassicRateMonotonic * * @brief Classic Rate Monotonic Scheduler Implementation */ @@ -32,10 +32,12 @@ extern "C" { #endif /** - * @defgroup ClassicRateMonImpl Classic Rate Monotonic Scheduler Implementation + * @defgroup RTEMSImplClassicRateMonotonic Rate Monotonic Manager * * @ingroup RTEMSImplClassic * + * @brief This group contains the Rate Monotonic Manager implementation. + * * @{ */ diff --git a/cpukit/include/rtems/rtems/regiondata.h b/cpukit/include/rtems/rtems/regiondata.h index c64f623c1d..71cd833377 100644 --- a/cpukit/include/rtems/rtems/regiondata.h +++ b/cpukit/include/rtems/rtems/regiondata.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicRegionImpl + * @ingroup RTEMSImplClassicRegion * * @brief Classic Region Manager Data Structures */ @@ -27,7 +27,7 @@ extern "C" { #endif /** - * @addtogroup ClassicRegionImpl + * @addtogroup RTEMSImplClassicRegion * * @{ */ diff --git a/cpukit/include/rtems/rtems/regionimpl.h b/cpukit/include/rtems/rtems/regionimpl.h index e9213ce6c7..418d5d052d 100644 --- a/cpukit/include/rtems/rtems/regionimpl.h +++ b/cpukit/include/rtems/rtems/regionimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicRegionImpl + * @ingroup RTEMSImplClassicRegion * * @brief Classic Region Manager Implementation */ @@ -28,10 +28,12 @@ extern "C" { #endif /** - * @defgroup ClassicRegionImpl Classic Region Manager Implementation + * @defgroup RTEMSImplClassicRegion Region Manager * * @ingroup RTEMSImplClassic * + * @brief This group contains the Region Manager implementation. + * * @{ */ diff --git a/cpukit/include/rtems/rtems/semdata.h b/cpukit/include/rtems/rtems/semdata.h index 497f786dfb..e780ff40d7 100644 --- a/cpukit/include/rtems/rtems/semdata.h +++ b/cpukit/include/rtems/rtems/semdata.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicSemImpl + * @ingroup RTEMSImplClassicSemaphore * * @brief Classic Semaphore Manager Data Structures */ @@ -29,7 +29,7 @@ extern "C" { #endif /** - * @addtogroup ClassicSemImpl + * @addtogroup RTEMSImplClassicSemaphore * * @{ */ diff --git a/cpukit/include/rtems/rtems/semimpl.h b/cpukit/include/rtems/rtems/semimpl.h index 3cf7b9cdaf..c84c3d2a76 100644 --- a/cpukit/include/rtems/rtems/semimpl.h +++ b/cpukit/include/rtems/rtems/semimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicSemImpl + * @ingroup RTEMSImplClassicSemaphore * * @brief Classic Semaphore Manager Implementation */ @@ -27,10 +27,12 @@ extern "C" { #endif /** - * @defgroup ClassicSemImpl Semaphore Manager Implementation + * @defgroup RTEMSImplClassicSemaphore Semaphore Manager * * @ingroup RTEMSImplClassic * + * @brief This group contains the Semaphore Manager implementation. + * * @{ */ diff --git a/cpukit/include/rtems/rtems/semmp.h b/cpukit/include/rtems/rtems/semmp.h index 68b5e60c6d..a516b111e2 100644 --- a/cpukit/include/rtems/rtems/semmp.h +++ b/cpukit/include/rtems/rtems/semmp.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicSEM + * @ingroup RTEMSImplClassicSemaphoreMP * * This include file contains all the constants and structures associated * with the Multiprocessing Support in the Semaphore Manager. @@ -27,14 +27,16 @@ extern "C" { #endif /** - * @defgroup ClassicSEM Semaphore MP Support + * @defgroup RTEMSImplClassicSemaphoreMP \ + * Semaphore Manager Multiprocessing (MP) Support * - * @ingroup ClassicMP + * @ingroup RTEMSImplClassicSemaphore * - * This encapsulates functionality related to the transparent multiprocessing - * support within the Classic API Semaphore Manager. + * @brief This group contains the implementation to support the Semaphore Manager + * in multiprocessing (MP) configurations. + * + * @{ */ -/**@{*/ /** * The following enumerated type defines the list of diff --git a/cpukit/include/rtems/rtems/signalimpl.h b/cpukit/include/rtems/rtems/signalimpl.h index 5945398c54..282b29fb48 100644 --- a/cpukit/include/rtems/rtems/signalimpl.h +++ b/cpukit/include/rtems/rtems/signalimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicSignalImpl + * @ingroup RTEMSImplClassicSignal * * @brief Signals Implementation */ @@ -25,11 +25,14 @@ extern "C" { #endif /** - * @defgroup ClassicSignalImpl Signals Implementation + * @defgroup RTEMSImplClassicSignal Signal Manager * * @ingroup RTEMSImplClassic + * + * @brief This group contains the Signal Manager implementation. + * + * @{ */ -/**@{*/ void _Signal_Action_handler( Thread_Control *executing, diff --git a/cpukit/include/rtems/rtems/signalmp.h b/cpukit/include/rtems/rtems/signalmp.h index b22e92d9b3..240a271755 100644 --- a/cpukit/include/rtems/rtems/signalmp.h +++ b/cpukit/include/rtems/rtems/signalmp.h @@ -1,7 +1,7 @@ /** * @file * - * @brief Signal MP Support + * @ingroup RTEMSImplClassicSignalMP * * This include file contains all the constants and structures associated * with the Multiprocessing Support in the Signal Manager. @@ -29,14 +29,16 @@ extern "C" { #endif /** - * @defgroup ClassicSignalMP Signal MP Support + * @defgroup RTEMSImplClassicSignalMP \ + * Signal Manager Multiprocessing (MP) Support * - * @ingroup ClassicMP + * @ingroup RTEMSImplClassicSignal * - * This encapsulates functionality related to the transparent multiprocessing - * support within the Classic API Signal Manager. + * @brief This group contains the implementation to support the Signal Manager + * in multiprocessing (MP) configurations. + * + * @{ */ -/*{*/ /* * @brief Signal_MP_Send_process_packet diff --git a/cpukit/include/rtems/rtems/statusimpl.h b/cpukit/include/rtems/rtems/statusimpl.h index 77a081be56..fc67fb6768 100644 --- a/cpukit/include/rtems/rtems/statusimpl.h +++ b/cpukit/include/rtems/rtems/statusimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicStatusImpl + * @ingroup RTEMSImplClassicStatus * * @brief Classic Status Implementation */ @@ -25,10 +25,13 @@ extern "C" { #endif /** - * @defgroup ClassicStatusImpl Classic Status Implementation + * @defgroup RTEMSImplClassicStatus Directive Status * * @ingroup RTEMSImplClassic * + * @brief This group contains the implementation to support directive status + * codes. + * * @{ */ diff --git a/cpukit/include/rtems/rtems/taskmp.h b/cpukit/include/rtems/rtems/taskmp.h index dd5d094b67..d0f4b6f6ee 100644 --- a/cpukit/include/rtems/rtems/taskmp.h +++ b/cpukit/include/rtems/rtems/taskmp.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicTaskMP + * @ingroup RTEMSImplClassicTaskMP * * This include file contains all the constants and structures associated * with the multiprocessing support in the task manager. @@ -29,14 +29,16 @@ extern "C" { #endif /** - * @defgroup ClassicTaskMP Task MP Support + * @defgroup RTEMSImplClassicTaskMP \ + * Task Manager Multiprocessing (MP) Support * - * @ingroup ClassicMP + * @ingroup RTEMSImplClassicTask * - * This encapsulates functionality related to the transparent multiprocessing - * support within the Classic API Task Manager. + * @brief This group contains the implementation to support the Task Manager + * in multiprocessing (MP) configurations. + * + * @{ */ -/**@{*/ /** * The following enumerated type defines the list of diff --git a/cpukit/include/rtems/rtems/tasksdata.h b/cpukit/include/rtems/rtems/tasksdata.h index 4339bfb6e0..ff9fceb1d9 100644 --- a/cpukit/include/rtems/rtems/tasksdata.h +++ b/cpukit/include/rtems/rtems/tasksdata.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicTasksImpl + * @ingroup RTEMSImplClassicTask * * @brief Classic Tasks Manager Data Structures */ @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @addtogroup ClassicTasksImpl + * @addtogroup RTEMSImplClassicTask * * @{ */ diff --git a/cpukit/include/rtems/rtems/tasksimpl.h b/cpukit/include/rtems/rtems/tasksimpl.h index 5eb412c46d..fc9d1e04f8 100644 --- a/cpukit/include/rtems/rtems/tasksimpl.h +++ b/cpukit/include/rtems/rtems/tasksimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicTasksImpl + * @ingroup RTEMSImplClassicTask * * @brief Classic Tasks Manager Implementation */ @@ -27,10 +27,12 @@ extern "C" { #endif /** - * @defgroup ClassicTasksImpl Classic Tasks Manager Implementation + * @defgroup RTEMSImplClassicTask Task Manager * * @ingroup RTEMSImplClassic * + * @brief This group contains the Task Manager implementation. + * * @{ */ diff --git a/cpukit/include/rtems/rtems/timerdata.h b/cpukit/include/rtems/rtems/timerdata.h index ed00671b10..6edbad2ba8 100644 --- a/cpukit/include/rtems/rtems/timerdata.h +++ b/cpukit/include/rtems/rtems/timerdata.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicTimerImpl + * @ingroup RTEMSImplClassicTimer * * @brief Classic Partition Manager Data Structures */ @@ -29,7 +29,7 @@ extern "C" { #endif /** - * @addtogroup ClassicTimerImpl + * @addtogroup RTEMSImplClassicTimer * * @{ */ diff --git a/cpukit/include/rtems/rtems/timerimpl.h b/cpukit/include/rtems/rtems/timerimpl.h index 4dd7951321..5305aa064a 100644 --- a/cpukit/include/rtems/rtems/timerimpl.h +++ b/cpukit/include/rtems/rtems/timerimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicTimerImpl + * @ingroup RTEMSImplClassicTimer * * @brief Classic Timer Implementation */ @@ -30,10 +30,12 @@ extern "C" { #endif /** - * @defgroup ClassicTimerImpl Classic Timer Implementation + * @defgroup RTEMSImplClassicTimer Timer Manager * * @ingroup RTEMSImplClassic * + * @brief This group contains the Timer Manager implementation. + * * @{ */ diff --git a/cpukit/include/rtems/rtems/types.h b/cpukit/include/rtems/rtems/types.h index ecb28ed60d..32b45113c8 100644 --- a/cpukit/include/rtems/rtems/types.h +++ b/cpukit/include/rtems/rtems/types.h @@ -67,6 +67,16 @@ extern "C" { #endif +/* Generated from spec:/rtems/req/group */ + +/** + * @defgroup RTEMSImplClassic Classic API + * + * @ingroup RTEMSImpl + * + * @brief This group contains the Classic API implementation. + */ + /* Generated from spec:/rtems/type/if/group */ /** |