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. --- cpukit/doxygen.h | 8 -------- cpukit/include/rtems/extensiondata.h | 4 ++-- cpukit/include/rtems/extensionimpl.h | 6 ++++-- cpukit/include/rtems/rtems/asrdata.h | 4 ++-- cpukit/include/rtems/rtems/asrimpl.h | 7 +++++-- cpukit/include/rtems/rtems/attrimpl.h | 7 +++++-- cpukit/include/rtems/rtems/barrierdata.h | 4 ++-- cpukit/include/rtems/rtems/barrierimpl.h | 10 ++++++---- cpukit/include/rtems/rtems/dpmemdata.h | 4 ++-- cpukit/include/rtems/rtems/dpmemimpl.h | 6 ++++-- cpukit/include/rtems/rtems/eventdata.h | 4 ++-- cpukit/include/rtems/rtems/eventimpl.h | 6 ++++-- cpukit/include/rtems/rtems/eventmp.h | 16 ++++++++++------ cpukit/include/rtems/rtems/messagedata.h | 2 +- cpukit/include/rtems/rtems/messageimpl.h | 10 ++++++---- cpukit/include/rtems/rtems/modesimpl.h | 6 ++++-- cpukit/include/rtems/rtems/msgmp.h | 14 +++++++++----- cpukit/include/rtems/rtems/objectimpl.h | 6 ++++-- cpukit/include/rtems/rtems/optionsimpl.h | 6 ++++-- cpukit/include/rtems/rtems/partdata.h | 4 ++-- cpukit/include/rtems/rtems/partimpl.h | 6 ++++-- cpukit/include/rtems/rtems/partmp.h | 14 +++++++++----- cpukit/include/rtems/rtems/ratemondata.h | 4 ++-- cpukit/include/rtems/rtems/ratemonimpl.h | 6 ++++-- cpukit/include/rtems/rtems/regiondata.h | 4 ++-- cpukit/include/rtems/rtems/regionimpl.h | 6 ++++-- cpukit/include/rtems/rtems/semdata.h | 4 ++-- cpukit/include/rtems/rtems/semimpl.h | 6 ++++-- cpukit/include/rtems/rtems/semmp.h | 14 ++++++++------ cpukit/include/rtems/rtems/signalimpl.h | 9 ++++++--- cpukit/include/rtems/rtems/signalmp.h | 14 ++++++++------ cpukit/include/rtems/rtems/statusimpl.h | 7 +++++-- cpukit/include/rtems/rtems/taskmp.h | 14 ++++++++------ cpukit/include/rtems/rtems/tasksdata.h | 4 ++-- cpukit/include/rtems/rtems/tasksimpl.h | 6 ++++-- cpukit/include/rtems/rtems/timerdata.h | 4 ++-- cpukit/include/rtems/rtems/timerimpl.h | 6 ++++-- cpukit/include/rtems/rtems/types.h | 10 ++++++++++ cpukit/rtems/src/barrierident.c | 2 +- cpukit/rtems/src/dpmemident.c | 2 +- cpukit/rtems/src/eventmp.c | 2 +- cpukit/rtems/src/eventreceive.c | 2 +- cpukit/rtems/src/eventseize.c | 2 +- cpukit/rtems/src/eventsend.c | 2 +- cpukit/rtems/src/eventsurrender.c | 2 +- cpukit/rtems/src/msgqcreate.c | 2 +- cpukit/rtems/src/msgqident.c | 2 +- cpukit/rtems/src/part.c | 2 +- cpukit/rtems/src/partcreate.c | 2 +- cpukit/rtems/src/partdelete.c | 2 +- cpukit/rtems/src/partgetbuffer.c | 2 +- cpukit/rtems/src/partident.c | 2 +- cpukit/rtems/src/partreturnbuffer.c | 2 +- cpukit/rtems/src/ratemonident.c | 2 +- cpukit/rtems/src/regionident.c | 2 +- cpukit/rtems/src/rtemsmaxprio.c | 2 +- cpukit/rtems/src/rtemsnametoid.c | 2 +- cpukit/rtems/src/semident.c | 2 +- cpukit/rtems/src/systemeventreceive.c | 2 +- cpukit/rtems/src/systemeventsend.c | 2 +- cpukit/rtems/src/taskident.c | 2 +- cpukit/rtems/src/timerident.c | 2 +- cpukit/sapi/src/extensionident.c | 2 +- 63 files changed, 191 insertions(+), 131 deletions(-) diff --git a/cpukit/doxygen.h b/cpukit/doxygen.h index 0428424476..2d9cf29c13 100644 --- a/cpukit/doxygen.h +++ b/cpukit/doxygen.h @@ -1,11 +1,3 @@ -/** - * @defgroup RTEMSImplClassic Classic - * - * @ingroup RTEMSImpl - * - * @brief Classic - */ - /** * @defgroup RTEMSAPIIO IO * diff --git a/cpukit/include/rtems/extensiondata.h b/cpukit/include/rtems/extensiondata.h index 61319d5668..63614329af 100644 --- a/cpukit/include/rtems/extensiondata.h +++ b/cpukit/include/rtems/extensiondata.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicUserExtensionsImpl + * @ingroup RTEMSImplClassicUserExt * * @brief Classic User Extensions Data Structures */ @@ -27,7 +27,7 @@ extern "C" { #endif /** - * @addtogroup ClassicUserExtensionsImpl + * @addtogroup RTEMSImplClassicUserExt * * @{ */ diff --git a/cpukit/include/rtems/extensionimpl.h b/cpukit/include/rtems/extensionimpl.h index ed9da1fa28..502aac87ca 100644 --- a/cpukit/include/rtems/extensionimpl.h +++ b/cpukit/include/rtems/extensionimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicUserExtensionsImpl + * @ingroup RTEMSImplClassicUserExt * * @brief Classic User Extensions Implementation */ @@ -26,10 +26,12 @@ extern "C" { #endif /** - * @defgroup ClassicUserExtensionsImpl User Extensions Implementation + * @defgroup RTEMSImplClassicUserExt User Extensions Manager * * @ingroup RTEMSImplClassic * + * @brief This group contains the User Extensions Manager implementation. + * * @{ */ 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 */ /** diff --git a/cpukit/rtems/src/barrierident.c b/cpukit/rtems/src/barrierident.c index 928cc0ce9e..1cff99829d 100644 --- a/cpukit/rtems/src/barrierident.c +++ b/cpukit/rtems/src/barrierident.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup ClassicBarrierImpl + * @ingroup RTEMSImplClassicBarrier * * @brief rtems_barrier_ident() Implementation */ diff --git a/cpukit/rtems/src/dpmemident.c b/cpukit/rtems/src/dpmemident.c index 38d906833f..679933a770 100644 --- a/cpukit/rtems/src/dpmemident.c +++ b/cpukit/rtems/src/dpmemident.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup ClassicDPMEMImpl + * @ingroup RTEMSImplClassicDPMem * * @brief rtems_port_ident() Implementation */ diff --git a/cpukit/rtems/src/eventmp.c b/cpukit/rtems/src/eventmp.c index a31476af74..d1968d3e98 100644 --- a/cpukit/rtems/src/eventmp.c +++ b/cpukit/rtems/src/eventmp.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicEventMP + * @ingroup RTEMSImplClassicEventMP * * @brief This source file contains the implementation of the task event MPCI * support. diff --git a/cpukit/rtems/src/eventreceive.c b/cpukit/rtems/src/eventreceive.c index fc5886b524..4a8b720dd9 100644 --- a/cpukit/rtems/src/eventreceive.c +++ b/cpukit/rtems/src/eventreceive.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicEventImpl + * @ingroup RTEMSImplClassicEvent * * @brief This source file contains the implementation of * rtems_event_receive(). diff --git a/cpukit/rtems/src/eventseize.c b/cpukit/rtems/src/eventseize.c index 874c142c1a..9574ba13ec 100644 --- a/cpukit/rtems/src/eventseize.c +++ b/cpukit/rtems/src/eventseize.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicEventImpl + * @ingroup RTEMSImplClassicEvent * * @brief This source file contains the implementation of * _Event_Seize() and the task event MPCI support system initialization. diff --git a/cpukit/rtems/src/eventsend.c b/cpukit/rtems/src/eventsend.c index 470b7f4601..6d0434d6ad 100644 --- a/cpukit/rtems/src/eventsend.c +++ b/cpukit/rtems/src/eventsend.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicEventImpl + * @ingroup RTEMSImplClassicEvent * * @brief This source file contains the implementation of * rtems_event_send(). diff --git a/cpukit/rtems/src/eventsurrender.c b/cpukit/rtems/src/eventsurrender.c index 6cdaafaa97..48c08e486f 100644 --- a/cpukit/rtems/src/eventsurrender.c +++ b/cpukit/rtems/src/eventsurrender.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicEventImpl + * @ingroup RTEMSImplClassicEvent * * @brief This source file contains the implementation of * _Event_Surrender(). diff --git a/cpukit/rtems/src/msgqcreate.c b/cpukit/rtems/src/msgqcreate.c index 7469f10509..be3a49310b 100644 --- a/cpukit/rtems/src/msgqcreate.c +++ b/cpukit/rtems/src/msgqcreate.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup ClassicMessageQueueImpl + * @ingroup RTEMSImplClassicMessage * * @brief This source file contains the implementation of * rtems_message_queue_create(). diff --git a/cpukit/rtems/src/msgqident.c b/cpukit/rtems/src/msgqident.c index dfd68d21f0..fd5728d51e 100644 --- a/cpukit/rtems/src/msgqident.c +++ b/cpukit/rtems/src/msgqident.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup ClassicMessageQueueImpl + * @ingroup RTEMSImplClassicMessage * * @brief rtems_message_queue_ident() Implementation */ diff --git a/cpukit/rtems/src/part.c b/cpukit/rtems/src/part.c index 0d7e352b60..8fcfdf546d 100644 --- a/cpukit/rtems/src/part.c +++ b/cpukit/rtems/src/part.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicPartImpl + * @ingroup RTEMSImplClassicPartition * * @brief This source file contains a definition of ::_Partition_Information * with zero objects. diff --git a/cpukit/rtems/src/partcreate.c b/cpukit/rtems/src/partcreate.c index 7eea6b3bcf..ca8e4693b8 100644 --- a/cpukit/rtems/src/partcreate.c +++ b/cpukit/rtems/src/partcreate.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicPartImpl + * @ingroup RTEMSImplClassicPartition * * @brief This source file contains the implementation of * rtems_partition_create(). diff --git a/cpukit/rtems/src/partdelete.c b/cpukit/rtems/src/partdelete.c index f0d04f94a0..37123dc6ad 100644 --- a/cpukit/rtems/src/partdelete.c +++ b/cpukit/rtems/src/partdelete.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicPartImpl + * @ingroup RTEMSImplClassicPartition * * @brief This source file contains the implementation of * rtems_partition_delete(). diff --git a/cpukit/rtems/src/partgetbuffer.c b/cpukit/rtems/src/partgetbuffer.c index 2061ff151e..8d7c3d5312 100644 --- a/cpukit/rtems/src/partgetbuffer.c +++ b/cpukit/rtems/src/partgetbuffer.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicPartImpl + * @ingroup RTEMSImplClassicPartition * * @brief This source file contains the implementation of * rtems_partition_get_buffer(). diff --git a/cpukit/rtems/src/partident.c b/cpukit/rtems/src/partident.c index fb509fddfd..fc1c108add 100644 --- a/cpukit/rtems/src/partident.c +++ b/cpukit/rtems/src/partident.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup ClassicPartImpl + * @ingroup RTEMSImplClassicPartition * * @brief This source file contains the implementation of * rtems_partition_ident(). diff --git a/cpukit/rtems/src/partreturnbuffer.c b/cpukit/rtems/src/partreturnbuffer.c index 6d7b71a7e5..f5ab7d85f9 100644 --- a/cpukit/rtems/src/partreturnbuffer.c +++ b/cpukit/rtems/src/partreturnbuffer.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicPartImpl + * @ingroup RTEMSImplClassicPartition * * @brief This source file contains the implementation of * rtems_partition_return_buffer(). diff --git a/cpukit/rtems/src/ratemonident.c b/cpukit/rtems/src/ratemonident.c index 67ba13b476..8a62f2752c 100644 --- a/cpukit/rtems/src/ratemonident.c +++ b/cpukit/rtems/src/ratemonident.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup ClassicRateMonImpl + * @ingroup RTEMSImplClassicRateMonotonic * * @brief rtems_rate_monotonic_ident() Implementation */ diff --git a/cpukit/rtems/src/regionident.c b/cpukit/rtems/src/regionident.c index c8a643c356..3eadd4afad 100644 --- a/cpukit/rtems/src/regionident.c +++ b/cpukit/rtems/src/regionident.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup ClassicRegionImpl + * @ingroup RTEMSImplClassicRegion * * @brief rtems_region_ident() Implementation */ diff --git a/cpukit/rtems/src/rtemsmaxprio.c b/cpukit/rtems/src/rtemsmaxprio.c index 5a46c6be91..1ed5166962 100644 --- a/cpukit/rtems/src/rtemsmaxprio.c +++ b/cpukit/rtems/src/rtemsmaxprio.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicTasksImpl + * @ingroup RTEMSImplClassicTask */ /* diff --git a/cpukit/rtems/src/rtemsnametoid.c b/cpukit/rtems/src/rtemsnametoid.c index 43a6d20908..7fc778ba8c 100644 --- a/cpukit/rtems/src/rtemsnametoid.c +++ b/cpukit/rtems/src/rtemsnametoid.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup ClassicObjectImpl + * @ingroup RTEMSImplClassicObject * * @brief _RTEMS_Name_to_id() Implementation */ diff --git a/cpukit/rtems/src/semident.c b/cpukit/rtems/src/semident.c index 93c325c48d..5edfb20180 100644 --- a/cpukit/rtems/src/semident.c +++ b/cpukit/rtems/src/semident.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup ClassicSemImpl + * @ingroup RTEMSImplClassicSemaphore * * @brief rtems_semaphore_ident() Implementation */ diff --git a/cpukit/rtems/src/systemeventreceive.c b/cpukit/rtems/src/systemeventreceive.c index 30e5adcd2c..90d3b03373 100644 --- a/cpukit/rtems/src/systemeventreceive.c +++ b/cpukit/rtems/src/systemeventreceive.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicEventImpl + * @ingroup RTEMSImplClassicEvent * * @brief This source file contains the implementation of * rtems_event_system_receive(). diff --git a/cpukit/rtems/src/systemeventsend.c b/cpukit/rtems/src/systemeventsend.c index 6a83ec4726..013ea5e88f 100644 --- a/cpukit/rtems/src/systemeventsend.c +++ b/cpukit/rtems/src/systemeventsend.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup ClassicEventImpl + * @ingroup RTEMSImplClassicEvent * * @brief This source file contains the implementation of * rtems_event_system_send(). diff --git a/cpukit/rtems/src/taskident.c b/cpukit/rtems/src/taskident.c index 501bd0b05f..c92a050f29 100644 --- a/cpukit/rtems/src/taskident.c +++ b/cpukit/rtems/src/taskident.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup ClassicTasksImpl + * @ingroup RTEMSImplClassicTask * * @brief rtems_task_ident() Implementation */ diff --git a/cpukit/rtems/src/timerident.c b/cpukit/rtems/src/timerident.c index 8259507c15..273af1564c 100644 --- a/cpukit/rtems/src/timerident.c +++ b/cpukit/rtems/src/timerident.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup ClassicTimerImpl + * @ingroup RTEMSImplClassicTimer * * @brief rtems_timer_ident() Implementation */ diff --git a/cpukit/sapi/src/extensionident.c b/cpukit/sapi/src/extensionident.c index d408f68dd1..aa0dfca5ab 100644 --- a/cpukit/sapi/src/extensionident.c +++ b/cpukit/sapi/src/extensionident.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup ClassicUserExtensionsImpl + * @ingroup RTEMSImplClassicUserExt * * @brief rtems_extension_ident() Implementation */ -- 2.26.2 _______________________________________________ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel