From c81ac0e750776294fce56f6744671e3090b0579a Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Thu, 26 Nov 2020 10:42:03 +0100 Subject: score: Canonicalize Doxygen groups Adjust group identifier and names to be in line with a common pattern. Use common phrases for the group brief descriptions. Update #3706. --- cpukit/include/rtems/score/address.h | 2 +- cpukit/include/rtems/score/apimutex.h | 5 ++++- cpukit/include/rtems/score/assert.h | 2 +- cpukit/include/rtems/score/atomic.h | 2 +- cpukit/include/rtems/score/chain.h | 2 +- cpukit/include/rtems/score/context.h | 2 +- cpukit/include/rtems/score/copyrt.h | 7 ++++--- cpukit/include/rtems/score/corebarrier.h | 2 +- cpukit/include/rtems/score/coremsg.h | 2 +- cpukit/include/rtems/score/coremutex.h | 2 +- cpukit/include/rtems/score/corerwlockimpl.h | 11 ++++++----- cpukit/include/rtems/score/coresem.h | 2 +- cpukit/include/rtems/score/cpustdatomic.h | 7 ++++--- cpukit/include/rtems/score/freechain.h | 8 ++++---- cpukit/include/rtems/score/heap.h | 2 +- cpukit/include/rtems/score/interr.h | 5 ++--- cpukit/include/rtems/score/io.h | 12 ++++++++++++ cpukit/include/rtems/score/isr.h | 5 ++--- cpukit/include/rtems/score/isrlock.h | 10 ++++++---- cpukit/include/rtems/score/memory.h | 6 ++++-- cpukit/include/rtems/score/mpci.h | 2 +- cpukit/include/rtems/score/mppkt.h | 7 ++++--- cpukit/include/rtems/score/mrsp.h | 5 +++-- cpukit/include/rtems/score/object.h | 13 ++++++------- cpukit/include/rtems/score/objectmp.h | 7 ++++--- cpukit/include/rtems/score/onceimpl.h | 5 +++-- cpukit/include/rtems/score/percpu.h | 14 ++++++++------ cpukit/include/rtems/score/percpudata.h | 15 ++++++++------- cpukit/include/rtems/score/priority.h | 2 +- cpukit/include/rtems/score/prioritybitmap.h | 4 ++-- cpukit/include/rtems/score/prioritybitmapimpl.h | 2 +- cpukit/include/rtems/score/processormask.h | 2 +- cpukit/include/rtems/score/profiling.h | 2 +- cpukit/include/rtems/score/protectedheap.h | 2 +- cpukit/include/rtems/score/rbtree.h | 2 +- cpukit/include/rtems/score/schedulercbs.h | 5 +++-- cpukit/include/rtems/score/scheduleredf.h | 2 +- cpukit/include/rtems/score/scheduleredfsmp.h | 5 +++-- cpukit/include/rtems/score/schedulerimpl.h | 6 ++++-- cpukit/include/rtems/score/schedulerpriority.h | 3 ++- cpukit/include/rtems/score/schedulerpriorityaffinitysmp.h | 3 ++- cpukit/include/rtems/score/schedulerprioritysmp.h | 2 +- cpukit/include/rtems/score/schedulersimple.h | 2 +- cpukit/include/rtems/score/schedulersimplesmp.h | 2 +- cpukit/include/rtems/score/schedulersmp.h | 2 +- cpukit/include/rtems/score/schedulerstrongapa.h | 2 +- cpukit/include/rtems/score/smp.h | 4 +--- cpukit/include/rtems/score/smpbarrier.h | 6 ++++-- cpukit/include/rtems/score/smpimpl.h | 2 +- cpukit/include/rtems/score/smplock.h | 5 +++-- cpukit/include/rtems/score/stack.h | 2 +- cpukit/include/rtems/score/states.h | 2 +- cpukit/include/rtems/score/sysstate.h | 2 +- cpukit/include/rtems/score/thread.h | 2 +- cpukit/include/rtems/score/threadmp.h | 7 ++++--- cpukit/include/rtems/score/threadq.h | 2 +- cpukit/include/rtems/score/timecounter.h | 2 +- cpukit/include/rtems/score/timespec.h | 8 +++----- cpukit/include/rtems/score/timestamp.h | 6 +++--- cpukit/include/rtems/score/timestampimpl.h | 2 +- cpukit/include/rtems/score/tls.h | 3 ++- cpukit/include/rtems/score/todimpl.h | 5 +++-- cpukit/include/rtems/score/userext.h | 12 +++++++----- cpukit/include/rtems/score/watchdog.h | 2 +- cpukit/include/rtems/score/wkspace.h | 6 ++++-- 65 files changed, 166 insertions(+), 128 deletions(-) (limited to 'cpukit/include') diff --git a/cpukit/include/rtems/score/address.h b/cpukit/include/rtems/score/address.h index 2735db5ca3..f93fcde7db 100644 --- a/cpukit/include/rtems/score/address.h +++ b/cpukit/include/rtems/score/address.h @@ -32,7 +32,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Support for Address Manipulation + * @brief This group contains the Address Handler implementation. * * This handler encapsulates functionality which abstracts address * manipulation in a portable manner. diff --git a/cpukit/include/rtems/score/apimutex.h b/cpukit/include/rtems/score/apimutex.h index e118269c3f..20d57b669f 100644 --- a/cpukit/include/rtems/score/apimutex.h +++ b/cpukit/include/rtems/score/apimutex.h @@ -27,7 +27,10 @@ * * @ingroup RTEMSScore * - * @brief Provides routines to ensure mutual exclusion on API level. + * @brief This group contains the API Mutex Handler implementation. + * + * This handler provides routines to ensure mutual exclusion in a thread + * context at the API level. * * @{ */ diff --git a/cpukit/include/rtems/score/assert.h b/cpukit/include/rtems/score/assert.h index 649d59b7e9..8ef9e29b4d 100644 --- a/cpukit/include/rtems/score/assert.h +++ b/cpukit/include/rtems/score/assert.h @@ -30,7 +30,7 @@ * * @ingroup RTEMSScore * - * @brief Support for Assert Statements + * @brief This group contains the Assert Handler implementation. * * @{ */ diff --git a/cpukit/include/rtems/score/atomic.h b/cpukit/include/rtems/score/atomic.h index f7d8b99af4..4aa73d0a57 100644 --- a/cpukit/include/rtems/score/atomic.h +++ b/cpukit/include/rtems/score/atomic.h @@ -24,7 +24,7 @@ * * @ingroup RTEMSScore * - * @brief Support for atomic operations. + * @brief This group contains the atomic operations implementation. * * Atomic operations can be used to implement low-level synchronization * primitives on SMP systems, like spin locks. All atomic operations are diff --git a/cpukit/include/rtems/score/chain.h b/cpukit/include/rtems/score/chain.h index bf32e5926f..fdfa963d07 100644 --- a/cpukit/include/rtems/score/chain.h +++ b/cpukit/include/rtems/score/chain.h @@ -29,7 +29,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Provides Data Structures Chain Node and Chain Control + * @brief This group contains the Chain Handler implementation. * * The Chain Handler is used to manage sets of entities. This handler * provides two data structures. The Chain Node data structure is included diff --git a/cpukit/include/rtems/score/context.h b/cpukit/include/rtems/score/context.h index 364f8c1182..b174fa27e6 100644 --- a/cpukit/include/rtems/score/context.h +++ b/cpukit/include/rtems/score/context.h @@ -25,7 +25,7 @@ * * @ingroup RTEMSScore * - * @brief Functionality for Abstraction of Thread Context Management + * @brief This group contains the Context Handler implementation. * * This handler encapsulates functionality which abstracts thread context * management in a portable manner. diff --git a/cpukit/include/rtems/score/copyrt.h b/cpukit/include/rtems/score/copyrt.h index 1d0ad09f29..b0916087e9 100644 --- a/cpukit/include/rtems/score/copyrt.h +++ b/cpukit/include/rtems/score/copyrt.h @@ -22,11 +22,12 @@ #define _RTEMS_SCORE_COPYRT_H /** - * @defgroup RTEMSSuperCoreCopyright RTEMS Copyright Notice + * @defgroup RTEMSScoreCopyright Copyright Notice * * @ingroup RTEMSScore * - * @brief Copyright Notice for RTEMS + * @brief This group contains the implementation to provide a copyright notice + * and the RTEMS version. * * @{ */ @@ -37,7 +38,7 @@ extern "C" { #endif /** - * This is the copyright string for RTEMS. + * @brief This is the copyright string for RTEMS. */ extern const char _Copyright_Notice[]; diff --git a/cpukit/include/rtems/score/corebarrier.h b/cpukit/include/rtems/score/corebarrier.h index 33798b33c8..40ccdec479 100644 --- a/cpukit/include/rtems/score/corebarrier.h +++ b/cpukit/include/rtems/score/corebarrier.h @@ -32,7 +32,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Functionality for Foundation Barrier Services + * @brief This group contains the Barrier Handler implementation. * * This handler encapsulates functionality which provides the foundation * Barrier services used in all of the APIs supported by RTEMS. diff --git a/cpukit/include/rtems/score/coremsg.h b/cpukit/include/rtems/score/coremsg.h index 51c638bcc3..4034577e96 100644 --- a/cpukit/include/rtems/score/coremsg.h +++ b/cpukit/include/rtems/score/coremsg.h @@ -35,7 +35,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Message Queue Handler + * @brief This group contains the Message Queue Handler implementation. * * This handler encapsulates functionality which provides the foundation * Message Queue services used in all of the APIs supported by RTEMS. diff --git a/cpukit/include/rtems/score/coremutex.h b/cpukit/include/rtems/score/coremutex.h index 7d3d831c1f..af1eb0136e 100644 --- a/cpukit/include/rtems/score/coremutex.h +++ b/cpukit/include/rtems/score/coremutex.h @@ -40,7 +40,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Mutex Handler + * @brief This group contains the Mutex Handler implementation. * * This handler encapsulates functionality which provides the foundation * Mutex services used in all of the APIs supported by RTEMS. diff --git a/cpukit/include/rtems/score/corerwlockimpl.h b/cpukit/include/rtems/score/corerwlockimpl.h index c06427a37e..37c0c425b7 100644 --- a/cpukit/include/rtems/score/corerwlockimpl.h +++ b/cpukit/include/rtems/score/corerwlockimpl.h @@ -28,13 +28,14 @@ #include /** - * @defgroup RTEMSScoreRWLock ScoreRWLock - * + * @defgroup RTEMSScoreRWLock Read-Write Lock + * * @ingroup RTEMSScore - * - * @brief ScoreRWLock + * + * @brief This group contains the Read-Write Lock implementation. + * + * @{ */ -/** @{ */ #ifdef __cplusplus extern "C" { diff --git a/cpukit/include/rtems/score/coresem.h b/cpukit/include/rtems/score/coresem.h index e1f22dc768..84b64eac1a 100644 --- a/cpukit/include/rtems/score/coresem.h +++ b/cpukit/include/rtems/score/coresem.h @@ -34,7 +34,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Semaphore Handler + * @brief This group contains the Semaphore Handler implementation. * * This handler encapsulates functionality which provides the foundation * Semaphore services used in all of the APIs supported by RTEMS. diff --git a/cpukit/include/rtems/score/cpustdatomic.h b/cpukit/include/rtems/score/cpustdatomic.h index 31a17932c6..ffdcf68097 100644 --- a/cpukit/include/rtems/score/cpustdatomic.h +++ b/cpukit/include/rtems/score/cpustdatomic.h @@ -19,11 +19,12 @@ #include /** - * @defgroup RTEMSScoreCPUAtomic Atomic Operations CPU + * @defgroup RTEMSScoreAtomicCPU C11/C++11 Atomic Operations * - * @ingroup RTEMSScore + * @ingroup RTEMSScoreAtomic * - * @brief Atomic Operations CPU API + * @brief This group contains the atomic operations implementation using + * functions provided by the C11/C++11. * * @{ */ diff --git a/cpukit/include/rtems/score/freechain.h b/cpukit/include/rtems/score/freechain.h index 7db1101cff..76b028fba0 100644 --- a/cpukit/include/rtems/score/freechain.h +++ b/cpukit/include/rtems/score/freechain.h @@ -27,11 +27,11 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief The Freechain Handler. + * @brief This group contains the Freechain Handler implementation. * - * The Freechain Handler is used to manage a chain of nodes, of which size can - * automatically increase when there is no free node left. This handler - * provides one data structure: Freechain_Control. + * This handler encapsulates functionality related to the management of + * free nodes of a user-defined size. If the chain of free nodes is empty + * during an allocation request, it can be dynamically extended. * * @{ */ diff --git a/cpukit/include/rtems/score/heap.h b/cpukit/include/rtems/score/heap.h index 4b620b2715..6426c82881 100644 --- a/cpukit/include/rtems/score/heap.h +++ b/cpukit/include/rtems/score/heap.h @@ -34,7 +34,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief The Heap Handler provides a heap. + * @brief This group contains the Heap Handler implementation. * * A heap is a doubly linked list of variable size blocks which are allocated * using the first fit method. Garbage collection is performed each time a diff --git a/cpukit/include/rtems/score/interr.h b/cpukit/include/rtems/score/interr.h index 01ece772b8..b3dd992eaf 100644 --- a/cpukit/include/rtems/score/interr.h +++ b/cpukit/include/rtems/score/interr.h @@ -28,10 +28,9 @@ * * @ingroup RTEMSScore * - * @brief Internal Error Handler + * @brief This group contains the Internal Error Handler implementation. * - * This handler encapsulates functionality which provides the foundation - * Semaphore services used in all of the APIs supported by RTEMS. + * This handler encapsulates functionality to terminate the system. * * @{ */ diff --git a/cpukit/include/rtems/score/io.h b/cpukit/include/rtems/score/io.h index cca559cff0..e125ea0b52 100644 --- a/cpukit/include/rtems/score/io.h +++ b/cpukit/include/rtems/score/io.h @@ -23,6 +23,16 @@ extern "C" { #endif /* __cplusplus */ +/** + * @defgroup RTEMSScoreIO IO Handler + * + * @ingroup RTEMSScore + * + * @brief This group contains the IO Handler implementation. + * + * @{ + */ + typedef void ( *IO_Put_char )( int c, void *arg ); int _IO_Printf( @@ -64,6 +74,8 @@ int _IO_Base64( int wordlen ); +/** @} */ + #ifdef __cplusplus } #endif /* __cplusplus */ diff --git a/cpukit/include/rtems/score/isr.h b/cpukit/include/rtems/score/isr.h index 6e7a0b1dc7..357648314e 100644 --- a/cpukit/include/rtems/score/isr.h +++ b/cpukit/include/rtems/score/isr.h @@ -30,13 +30,12 @@ * * @ingroup RTEMSScore * - * @brief ISR Handler + * @brief This group contains the ISR Handler implementation. * * This handler encapsulates functionality which provides the foundation * ISR services used in all of the APIs supported by RTEMS. * - * The ISR Nest level counter variable is maintained as part of the - * per cpu data structure. + * The ::_ISR_Nest_level variable is maintained by @ref RTEMSScorePerCPU. * * @{ */ diff --git a/cpukit/include/rtems/score/isrlock.h b/cpukit/include/rtems/score/isrlock.h index 14ea88b4e3..c9b3eaf42c 100644 --- a/cpukit/include/rtems/score/isrlock.h +++ b/cpukit/include/rtems/score/isrlock.h @@ -35,13 +35,15 @@ extern "C" { * * @ingroup RTEMSScoreISR * - * @brief Low-level lock to protect critical sections accessed by threads and - * interrupt service routines. + * @brief This group contains the ISR locks implementation. * - * On single processor configurations the ISR locks degrade to simple ISR + * The ISR locks are low-level locks to protect critical sections accessed by + * threads and interrupt service routines. + * + * In uniprocessor configurations the ISR locks degrade to simple ISR * disable/enable sequences. No additional storage or objects are required. * - * This synchronization primitive is supported on SMP configurations. Here SMP + * This synchronization primitive is supported in SMP configurations. Here SMP * locks are used. * * @{ diff --git a/cpukit/include/rtems/score/memory.h b/cpukit/include/rtems/score/memory.h index 440a59c793..d2c610973b 100644 --- a/cpukit/include/rtems/score/memory.h +++ b/cpukit/include/rtems/score/memory.h @@ -48,8 +48,10 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Low level handler to provide memory areas for higher level memory - * handlers such as the Workspace Handler. + * @brief This group contains the Memory Handler implementation. + * + * The Memory Handler provides memory areas supplied by the BSP to higher level memory + * consumers such as the @ref RTEMSScoreWorkspace and the @ref MallocSupport. * * @{ */ diff --git a/cpukit/include/rtems/score/mpci.h b/cpukit/include/rtems/score/mpci.h index 0de29739e8..25d1effdb5 100644 --- a/cpukit/include/rtems/score/mpci.h +++ b/cpukit/include/rtems/score/mpci.h @@ -32,7 +32,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief MPCI Handler + * @brief This group contains the MPCI Handler implementation. * * The MPCI Handler encapsulates functionality which is related to the * generation, receipt, and processing of remote operations in a diff --git a/cpukit/include/rtems/score/mppkt.h b/cpukit/include/rtems/score/mppkt.h index 1a00aa8ccd..fd7f883117 100644 --- a/cpukit/include/rtems/score/mppkt.h +++ b/cpukit/include/rtems/score/mppkt.h @@ -33,11 +33,12 @@ extern "C" { #endif /** - * @defgroup RTEMSScoreMPPacket MP Packet Handler + * @defgroup RTEMSScoreMPPacket Multiprocessing (MP) Packet Handler * - * @ingroup RTEMSScore + * @ingroup RTEMSScoreMPCI * - * @brief MP Packte Handler + * @brief This group contains the Multiprocessing (MP) Packet Handler + * implementation. * * This handler encapsulates the primary definition of MPCI packets. This * handler defines the part of the packet that is common to all remote diff --git a/cpukit/include/rtems/score/mrsp.h b/cpukit/include/rtems/score/mrsp.h index c7805aef57..e42c3a400c 100644 --- a/cpukit/include/rtems/score/mrsp.h +++ b/cpukit/include/rtems/score/mrsp.h @@ -34,11 +34,12 @@ extern "C" { #endif /* __cplusplus */ /** - * @defgroup RTEMSScoreMRSP Multiprocessor Resource Sharing Protocol Handler + * @defgroup RTEMSScoreMRSP Multiprocessor Resource Sharing Protocol (MrsP) * * @ingroup RTEMSScore * - * @brief Multiprocessor Resource Sharing Protocol (MrsP). + * @brief This group contains the implementation to support the Multiprocessor + * Resource Sharing Protocol (MrsP) . * * The Multiprocessor Resource Sharing Protocol (MrsP) is defined in A. Burns * and A.J. Wellings, A Schedulability Compatible Multiprocessor Resource diff --git a/cpukit/include/rtems/score/object.h b/cpukit/include/rtems/score/object.h index ffc896206b..561db194c2 100644 --- a/cpukit/include/rtems/score/object.h +++ b/cpukit/include/rtems/score/object.h @@ -34,9 +34,9 @@ extern "C" { * * @ingroup RTEMSImpl * - * @brief Provides services for all APIs. + * @brief This group contains the SuperCore implementation. * - * @{ + * The SuperCore provides services for all APIs. */ /** @@ -44,9 +44,8 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Provides CPU architecture dependent services. - * - * @{ + * @brief This group contains the implementation to support a processor + * architecture. */ /** @@ -54,6 +53,8 @@ extern "C" { * * @ingroup RTEMSScore * + * @brief This group contains the Object Handler implementation. + * * @{ */ @@ -347,8 +348,6 @@ extern uint16_t _Objects_Local_node; #define _Objects_Local_node ((uint16_t) 1) #endif -/** @} */ -/** @} */ /** @} */ #ifdef __cplusplus diff --git a/cpukit/include/rtems/score/objectmp.h b/cpukit/include/rtems/score/objectmp.h index 74a01de1a7..e9419d7bc0 100644 --- a/cpukit/include/rtems/score/objectmp.h +++ b/cpukit/include/rtems/score/objectmp.h @@ -32,11 +32,12 @@ extern "C" { #endif /** - * @defgroup RTEMSScoreObjectMP Object Handler Multiprocessing Support + * @defgroup RTEMSScoreObjectMP Object Handler Multiprocessing (MP) Support * - * @ingroup RTEMSScore + * @ingroup RTEMSScoreObject * - * @brief Object Handler Multiprocessing Support + * @brief This group contains the implementation to support the Object Handler + * in multiprocessing (MP) configurations. * * This handler encapsulates functionality which is used to manage * objects which have been declared to be globally visible. This handler diff --git a/cpukit/include/rtems/score/onceimpl.h b/cpukit/include/rtems/score/onceimpl.h index 921c4927b0..f3c298abe2 100644 --- a/cpukit/include/rtems/score/onceimpl.h +++ b/cpukit/include/rtems/score/onceimpl.h @@ -30,11 +30,12 @@ extern "C" { #endif /* __cplusplus */ /** - * @defgroup RTEMSScoreOnce Once Functions. + * @defgroup RTEMSScoreOnce Execute Once Support * * @ingroup RTEMSScore * - * @brief The _Once() function for pthread_once() and rtems_gxx_once(). + * @brief This group contains the implementation to execute a routine only + * once. * * @{ */ diff --git a/cpukit/include/rtems/score/percpu.h b/cpukit/include/rtems/score/percpu.h index 6ae2103d98..d2a904663b 100644 --- a/cpukit/include/rtems/score/percpu.h +++ b/cpukit/include/rtems/score/percpu.h @@ -78,14 +78,16 @@ struct _Thread_Control; struct Scheduler_Context; /** - * @defgroup PerCPU RTEMS Per CPU Information + * @defgroup RTEMSScorePerCPU Per-CPU Information * - * @ingroup RTEMSScore + * @ingroup RTEMSScore * - * This defines the per CPU state information required by RTEMS - * and the BSP. In an SMP configuration, there will be multiple - * instances of this data structure -- one per CPU -- and the - * current CPU number will be used as the index. + * @brief This group contains the implementation of the per-CPU information. + * + * The per-CPU information encapsulates state which is maintained for each + * configured processor in the system. There will be one instance of a + * ::Per_CPU_Control in the ::_Per_CPU_Information table for each configured + * processor in the system. */ /**@{*/ diff --git a/cpukit/include/rtems/score/percpudata.h b/cpukit/include/rtems/score/percpudata.h index ff6e517d0a..7e1f787b7e 100644 --- a/cpukit/include/rtems/score/percpudata.h +++ b/cpukit/include/rtems/score/percpudata.h @@ -1,9 +1,9 @@ /** * @file * - * @ingroup PerCPUData + * @ingroup RTEMSScorePerCPUData * - * @brief Definition of custom per-CPU items. + * @brief This header file provides the Flexible Per-CPU Data API. */ /* @@ -31,14 +31,15 @@ extern "C" { #endif /* __cplusplus */ /** - * @defgroup PerCPUData Flexible Per-CPU Data + * @defgroup RTEMSScorePerCPUData Flexible Per-CPU Data * - * @ingroup PerCPU + * @ingroup RTEMSScorePerCPU * - * @brief Flexible Per-CPU Data + * @brief This group contains the implementation to support flexible per-CPU + * data. * - * Provides the definition of custom per-CPU items. The items are collected in - * a special linker set. During system initialization the content of the + * Macros to define custom per-CPU items are provided. The items are collected + * in a special linker set. During system initialization the content of the * linker set is duplicated for all secondary processors using memory allocated * from the workspace. The begin and end of the per-CPU data area is cache * line aligned (CPU_CACHE_LINE_BYTES). diff --git a/cpukit/include/rtems/score/priority.h b/cpukit/include/rtems/score/priority.h index 54b91a871b..593543ae00 100644 --- a/cpukit/include/rtems/score/priority.h +++ b/cpukit/include/rtems/score/priority.h @@ -35,7 +35,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Priority Handler + * @brief This group contains the Priority Handler implementation. * * This handler encapsulates functionality which is used to manage thread * priorities. The actual priority of a thread is an aggregation of priority diff --git a/cpukit/include/rtems/score/prioritybitmap.h b/cpukit/include/rtems/score/prioritybitmap.h index 608eb58892..3cc8addc4b 100644 --- a/cpukit/include/rtems/score/prioritybitmap.h +++ b/cpukit/include/rtems/score/prioritybitmap.h @@ -28,9 +28,9 @@ extern "C" { #endif /** - * @defgroup RTEMSScorePriorityBitmap Bitmap Priority Thread Routines + * @defgroup RTEMSScorePriorityBitmap Priority Bitmap * - * @brief Bitmap Priority Thread Routines + * @brief This group contains the implementation to support priority bitmaps. * * @ingroup RTEMSScore * diff --git a/cpukit/include/rtems/score/prioritybitmapimpl.h b/cpukit/include/rtems/score/prioritybitmapimpl.h index 48dd7fc91e..60b58bed70 100644 --- a/cpukit/include/rtems/score/prioritybitmapimpl.h +++ b/cpukit/include/rtems/score/prioritybitmapimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup RTEMSScorePriority + * @ingroup RTEMSScorePriorityBitmap * * @brief Inlined Routines in the Priority Handler Bit Map Implementation * diff --git a/cpukit/include/rtems/score/processormask.h b/cpukit/include/rtems/score/processormask.h index 19ad5143da..2509169945 100644 --- a/cpukit/include/rtems/score/processormask.h +++ b/cpukit/include/rtems/score/processormask.h @@ -38,7 +38,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Processor Mask + * @brief This group contains the implementation to support processor masks. * * The processor mask provides a bit map large enough to provide one bit for * each processor in the system. It is a fixed size internal data type diff --git a/cpukit/include/rtems/score/profiling.h b/cpukit/include/rtems/score/profiling.h index 24bfc869c6..571a291f6a 100644 --- a/cpukit/include/rtems/score/profiling.h +++ b/cpukit/include/rtems/score/profiling.h @@ -35,7 +35,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Profiling support. + * @brief This group contains the implementation to support profiling. * * @{ */ diff --git a/cpukit/include/rtems/score/protectedheap.h b/cpukit/include/rtems/score/protectedheap.h index 1379464af2..da3c697077 100644 --- a/cpukit/include/rtems/score/protectedheap.h +++ b/cpukit/include/rtems/score/protectedheap.h @@ -30,7 +30,7 @@ extern "C" { * * @ingroup RTEMSScoreHeap * - * @brief Provides protected heap services. + * @brief This group contains the Protected Heap Handler implementation. * * The @ref ScoreAllocatorMutex is used to protect the heap accesses. * diff --git a/cpukit/include/rtems/score/rbtree.h b/cpukit/include/rtems/score/rbtree.h index aa94e62d9f..d023c21610 100644 --- a/cpukit/include/rtems/score/rbtree.h +++ b/cpukit/include/rtems/score/rbtree.h @@ -33,7 +33,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Red-Black Tree Handler. + * @brief This group contains the Red-Black Tree Handler implementation. * * The Red-Black Tree Handler is used to manage sets of entities. This handler * provides two data structures. The rbtree Node data structure is included diff --git a/cpukit/include/rtems/score/schedulercbs.h b/cpukit/include/rtems/score/schedulercbs.h index ee4af2fdd7..d9136d8067 100644 --- a/cpukit/include/rtems/score/schedulercbs.h +++ b/cpukit/include/rtems/score/schedulercbs.h @@ -35,11 +35,12 @@ extern "C" { #endif /** - * @defgroup RTEMSScoreSchedulerCBS CBS Scheduler + * @defgroup RTEMSScoreSchedulerCBS Constant Bandwidth Server (CBS) Scheduler * * @ingroup RTEMSScoreScheduler * - * @brief CBS Scheduler. + * @brief This group contains the Constant Bandwidth Server (CBS) Scheduler + * implementation. * * @{ */ diff --git a/cpukit/include/rtems/score/scheduleredf.h b/cpukit/include/rtems/score/scheduleredf.h index 7081859aec..d4d1787d2b 100644 --- a/cpukit/include/rtems/score/scheduleredf.h +++ b/cpukit/include/rtems/score/scheduleredf.h @@ -37,7 +37,7 @@ extern "C" { * * @ingroup RTEMSScoreScheduler * - * @brief EDF Scheduler + * @brief This group contains the EDF Scheduler implementation. * * @{ */ diff --git a/cpukit/include/rtems/score/scheduleredfsmp.h b/cpukit/include/rtems/score/scheduleredfsmp.h index bf759908f0..19b3d0beda 100644 --- a/cpukit/include/rtems/score/scheduleredfsmp.h +++ b/cpukit/include/rtems/score/scheduleredfsmp.h @@ -26,11 +26,12 @@ extern "C" { #endif /** - * @defgroup RTEMSScoreSchedulerSMPEDF EDF Priority SMP Scheduler + * @defgroup RTEMSScoreSchedulerSMPEDF Earliest Deadline First (EDF) Priority SMP Scheduler * * @ingroup RTEMSScoreSchedulerSMP * - * @brief EDF Priority SMP Scheduler + * @brief This group contains the Earliest Deadline First (EDF) Priority SMP + * Scheduler implementation. * * @{ */ diff --git a/cpukit/include/rtems/score/schedulerimpl.h b/cpukit/include/rtems/score/schedulerimpl.h index 5ad6b5d553..cb3556735c 100644 --- a/cpukit/include/rtems/score/schedulerimpl.h +++ b/cpukit/include/rtems/score/schedulerimpl.h @@ -38,8 +38,10 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief This handler encapsulates functionality related to managing sets of - * threads that are ready for execution. + * @brief This group contains the Scheduler Handler implementation. + * + * This handler encapsulates functionality related to managing sets of threads + * that are ready for execution. * * Schedulers are used by the system to manage sets of threads that are ready * for execution. A scheduler consists of diff --git a/cpukit/include/rtems/score/schedulerpriority.h b/cpukit/include/rtems/score/schedulerpriority.h index a3ca28fec9..74e2d07272 100644 --- a/cpukit/include/rtems/score/schedulerpriority.h +++ b/cpukit/include/rtems/score/schedulerpriority.h @@ -34,7 +34,8 @@ extern "C" { * * @ingroup RTEMSScoreScheduler * - * @brief Deterministic Priority Scheduler + * @brief This group contains the Deterministic Priority Scheduler + * implementation. * * @{ */ diff --git a/cpukit/include/rtems/score/schedulerpriorityaffinitysmp.h b/cpukit/include/rtems/score/schedulerpriorityaffinitysmp.h index 498ffcb7aa..679bf4b9a2 100644 --- a/cpukit/include/rtems/score/schedulerpriorityaffinitysmp.h +++ b/cpukit/include/rtems/score/schedulerpriorityaffinitysmp.h @@ -34,7 +34,8 @@ extern "C" { * * @ingroup RTEMSScoreSchedulerPrioritySMP * - * @brief Deterministic Priority Affinity SMP Scheduler + * @brief This group contains the Deterministic Priority Affinity SMP Scheduler + * implementation. * * This is an extension of the Deterministic Priority SMP Scheduler. which * is an implementation of the global fixed priority scheduler (G-FP). diff --git a/cpukit/include/rtems/score/schedulerprioritysmp.h b/cpukit/include/rtems/score/schedulerprioritysmp.h index acdff7f9f0..8a3955077b 100644 --- a/cpukit/include/rtems/score/schedulerprioritysmp.h +++ b/cpukit/include/rtems/score/schedulerprioritysmp.h @@ -36,7 +36,7 @@ extern "C" { * * @ingroup RTEMSScoreSchedulerSMP * - * @brief Deterministic Priority SMP Scheduler + * @brief This group contains the Deterministic Priority SMP Scheduler implementation. * * This is an implementation of the global fixed priority scheduler (G-FP). It * uses one ready chain per priority to ensure constant time insert operations. diff --git a/cpukit/include/rtems/score/schedulersimple.h b/cpukit/include/rtems/score/schedulersimple.h index 028a5d6262..32c77e2d59 100644 --- a/cpukit/include/rtems/score/schedulersimple.h +++ b/cpukit/include/rtems/score/schedulersimple.h @@ -32,7 +32,7 @@ extern "C" { * * @ingroup RTEMSScoreScheduler * - * @brief Simple Priority Scheduler + * @brief This group contains the Simple Priority Scheduler implementation. * * @{ */ diff --git a/cpukit/include/rtems/score/schedulersimplesmp.h b/cpukit/include/rtems/score/schedulersimplesmp.h index eeb07d848e..a7e0b82f4a 100644 --- a/cpukit/include/rtems/score/schedulersimplesmp.h +++ b/cpukit/include/rtems/score/schedulersimplesmp.h @@ -32,7 +32,7 @@ extern "C" { * * @ingroup RTEMSScoreSchedulerSMP * - * @brief Simple Priority SMP Scheduler + * @brief This group contains the Simple Priority SMP Scheduler implementation. * * The Simple Priority SMP Scheduler allocates a processor for the processor * count highest priority ready threads. The thread priority and position in diff --git a/cpukit/include/rtems/score/schedulersmp.h b/cpukit/include/rtems/score/schedulersmp.h index 268585f0be..464124c4ed 100644 --- a/cpukit/include/rtems/score/schedulersmp.h +++ b/cpukit/include/rtems/score/schedulersmp.h @@ -35,7 +35,7 @@ extern "C" { * * @ingroup RTEMSScoreScheduler * - * @brief SMP Scheduler + * @brief This group contains the SMP Scheduler implementation. * * @{ */ diff --git a/cpukit/include/rtems/score/schedulerstrongapa.h b/cpukit/include/rtems/score/schedulerstrongapa.h index 0ac28cb439..7387981454 100644 --- a/cpukit/include/rtems/score/schedulerstrongapa.h +++ b/cpukit/include/rtems/score/schedulerstrongapa.h @@ -36,7 +36,7 @@ extern "C" { * * @ingroup RTEMSScoreSchedulerSMP * - * @brief Strong APA Scheduler + * @brief This group contains the Strong APA Scheduler implementation. * * This is an implementation of the global fixed priority scheduler (G-FP). It * uses one ready chain per priority to ensure constant time insert operations. diff --git a/cpukit/include/rtems/score/smp.h b/cpukit/include/rtems/score/smp.h index 2722fbdcee..e4f0149f6b 100644 --- a/cpukit/include/rtems/score/smp.h +++ b/cpukit/include/rtems/score/smp.h @@ -29,9 +29,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief SMP Support - * - * This defines the interface of the SuperCore SMP support. + * @brief This group contains the implementation to support SMP systems. * * @{ */ diff --git a/cpukit/include/rtems/score/smpbarrier.h b/cpukit/include/rtems/score/smpbarrier.h index e39ba93b9e..cacde6438a 100644 --- a/cpukit/include/rtems/score/smpbarrier.h +++ b/cpukit/include/rtems/score/smpbarrier.h @@ -35,8 +35,10 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief The SMP barrier provides barrier synchronization for SMP systems at - * the lowest level. + * @brief This group contains the SMP barrier implementation. + * + * The SMP barrier provides barrier synchronization for SMP systems at the + * lowest level. * * The SMP barrier is implemented as a sense barrier, see also Herlihy and * Shavit, "The Art of Multiprocessor Programming", 17.3 Sense-Reversing diff --git a/cpukit/include/rtems/score/smpimpl.h b/cpukit/include/rtems/score/smpimpl.h index 1ba16fb135..a341d0d720 100644 --- a/cpukit/include/rtems/score/smpimpl.h +++ b/cpukit/include/rtems/score/smpimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup RTEMSScoreSMPImpl + * @ingroup RTEMSScoreSMP * * @brief SuperCore SMP Implementation */ diff --git a/cpukit/include/rtems/score/smplock.h b/cpukit/include/rtems/score/smplock.h index 8fa756c6e0..b59832d59e 100644 --- a/cpukit/include/rtems/score/smplock.h +++ b/cpukit/include/rtems/score/smplock.h @@ -27,8 +27,9 @@ * * @ingroup RTEMSScore * - * @brief The SMP lock provides mutual exclusion for SMP systems at the lowest - * level. + * @brief This group contains the SMP lock implementation. + * + * The SMP lock provides mutual exclusion in SMP systems at the lowest level. * * The SMP lock is implemented as a ticket lock. This provides fairness in * case of concurrent lock attempts. diff --git a/cpukit/include/rtems/score/stack.h b/cpukit/include/rtems/score/stack.h index e869a04db5..9751a12aa5 100644 --- a/cpukit/include/rtems/score/stack.h +++ b/cpukit/include/rtems/score/stack.h @@ -33,7 +33,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Stack Handler + * @brief This group contains the Stack Handler implementation. * * This handler encapsulates functionality which is used in the management * of thread stacks. diff --git a/cpukit/include/rtems/score/states.h b/cpukit/include/rtems/score/states.h index 2aeee37be3..6e9d60cb74 100644 --- a/cpukit/include/rtems/score/states.h +++ b/cpukit/include/rtems/score/states.h @@ -31,7 +31,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief SuperCore Thread States + * @brief This group contains the implementation to support thread states. * * This handler encapsulates functionality which relates to the management of * the state bitmap associated with each thread. diff --git a/cpukit/include/rtems/score/sysstate.h b/cpukit/include/rtems/score/sysstate.h index 647da1dea5..907dfcff0c 100644 --- a/cpukit/include/rtems/score/sysstate.h +++ b/cpukit/include/rtems/score/sysstate.h @@ -29,7 +29,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Management of the internal system state of RTEMS. + * @brief This group contains the System State Handler implementation. * * @{ */ diff --git a/cpukit/include/rtems/score/thread.h b/cpukit/include/rtems/score/thread.h index 1388744548..b1bc208127 100644 --- a/cpukit/include/rtems/score/thread.h +++ b/cpukit/include/rtems/score/thread.h @@ -62,7 +62,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Thread Handler + * @brief This group contains the Thread Handler implementation. * * This handler encapsulates functionality related to the management of * threads. This includes the creation, deletion, and scheduling of threads. diff --git a/cpukit/include/rtems/score/threadmp.h b/cpukit/include/rtems/score/threadmp.h index a80dbff0aa..3fc9d141fd 100644 --- a/cpukit/include/rtems/score/threadmp.h +++ b/cpukit/include/rtems/score/threadmp.h @@ -32,11 +32,12 @@ extern "C" { #endif /** - * @defgroup RTEMSScoreThreadMP Thread Handler Multiprocessing Support + * @defgroup RTEMSScoreThreadMP Thread Handler Multiprocessing (MP) Support * - * @ingroup RTEMSScore + * @ingroup RTEMSScoreThread * - * @brief Thread Handler Multiprocessing Support + * @brief This group contains the implementation to support the Thread Handler + * in multiprocessing (MP) configurations. * * This handler encapsulates functionality which is related to managing * threads in a multiprocessor system configuration. This handler must diff --git a/cpukit/include/rtems/score/threadq.h b/cpukit/include/rtems/score/threadq.h index 522be03970..7864905344 100644 --- a/cpukit/include/rtems/score/threadq.h +++ b/cpukit/include/rtems/score/threadq.h @@ -42,7 +42,7 @@ struct Scheduler_Node; * * @ingroup RTEMSScore * - * @brief Thread Queue Handler + * @brief This group contains the Thread Queue Handler implementation. * * This handler provides the capability to have threads block in * ordered sets. The sets may be ordered using the FIFO or priority diff --git a/cpukit/include/rtems/score/timecounter.h b/cpukit/include/rtems/score/timecounter.h index b71ccd3948..02e96d26b1 100644 --- a/cpukit/include/rtems/score/timecounter.h +++ b/cpukit/include/rtems/score/timecounter.h @@ -38,7 +38,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Timecounter Handler. + * @brief This group contains the Timecounter Handler implementation. * * @{ */ diff --git a/cpukit/include/rtems/score/timespec.h b/cpukit/include/rtems/score/timespec.h index b3d67980a8..98eb89fe6e 100644 --- a/cpukit/include/rtems/score/timespec.h +++ b/cpukit/include/rtems/score/timespec.h @@ -19,14 +19,12 @@ #define _RTEMS_SCORE_TIMESPEC_H /** - * @defgroup Timespec Helpers + * @defgroup RTEMSScoreTimespec Timespec Helpers * * @ingroup RTEMSScore * - * @brief Timespec Helpers - * - * This handler encapsulates functionality related to manipulating - * POSIX struct timespecs. + * @brief This group contains the implementation to support operations with + * variables of the POSIX defined struct timespec type. * * @{ */ diff --git a/cpukit/include/rtems/score/timestamp.h b/cpukit/include/rtems/score/timestamp.h index 69c31a67bb..3283d2449a 100644 --- a/cpukit/include/rtems/score/timestamp.h +++ b/cpukit/include/rtems/score/timestamp.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup SuperCoreTimeStamp + * @ingroup RTEMSScoreTimestamp * * @brief Helpers for Manipulating Timestamps * @@ -21,11 +21,11 @@ #define _RTEMS_SCORE_TIMESTAMP_H /** - * @defgroup SuperCoreTimeStamp Score Timestamp + * @defgroup RTEMSScoreTimestamp Timestamp Handler * * @ingroup RTEMSScore * - * @brief Score Timestamp + * @brief This group contains the Timestamp Handler implementation. * * This handler encapsulates functionality related to manipulating * SuperCore Timestamps. SuperCore Timestamps may be used to diff --git a/cpukit/include/rtems/score/timestampimpl.h b/cpukit/include/rtems/score/timestampimpl.h index 9e3be06803..11e675c7ca 100644 --- a/cpukit/include/rtems/score/timestampimpl.h +++ b/cpukit/include/rtems/score/timestampimpl.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup SuperCoreTimeStamp + * @ingroup RTEMSScoreTimestamp * * @brief Helpers for Manipulating Timestamps * diff --git a/cpukit/include/rtems/score/tls.h b/cpukit/include/rtems/score/tls.h index 57063990e7..5a0ae0633e 100644 --- a/cpukit/include/rtems/score/tls.h +++ b/cpukit/include/rtems/score/tls.h @@ -36,7 +36,8 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Thread-local storage (TLS) support. + * @brief This group contains the implementation to support thread-local + * storage (TLS). * * Variants I and II are according to Ulrich Drepper, "ELF Handling For * Thread-Local Storage". diff --git a/cpukit/include/rtems/score/todimpl.h b/cpukit/include/rtems/score/todimpl.h index b54d9a950c..6d3a97ccf9 100644 --- a/cpukit/include/rtems/score/todimpl.h +++ b/cpukit/include/rtems/score/todimpl.h @@ -35,7 +35,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Time of Day Handler + * @brief This group contains the Time of Day Handler implementation. * * The following constants are related to the time of day and are * independent of RTEMS. @@ -342,7 +342,8 @@ RTEMS_INLINE_ROUTINE bool _TOD_Is_set( void ) * * @ingroup RTEMSScoreTOD * - * @brief Time of Day Handler Action Hooks + * @brief This group contains the implementation to support Time of Day Handler + * action hooks. * * The following support registering a hook which is invoked * when the TOD is set. These can be used by a paravirtualized diff --git a/cpukit/include/rtems/score/userext.h b/cpukit/include/rtems/score/userext.h index 4d41212957..6775d6115b 100644 --- a/cpukit/include/rtems/score/userext.h +++ b/cpukit/include/rtems/score/userext.h @@ -27,15 +27,17 @@ extern "C" { struct _Thread_Control; /** - * @defgroup RTEMSScoreUserExt User Extension Handler + * @defgroup RTEMSScoreUserExt User Extensions Handler * * @ingroup RTEMSScore * - * @brief The User Extension Handler provides invocation of application - * dependent routines at critical points in the life of each thread and the - * system as a whole. + * @brief This group contains the User Extensions Handler implementation. + * + * This handler provides the invocation of application dependent routines at + * critical points in the life of each thread and the system as a whole. + * + * @{ */ -/**@{**/ /** * @brief Task create extension. diff --git a/cpukit/include/rtems/score/watchdog.h b/cpukit/include/rtems/score/watchdog.h index cd792a7b42..7e8727f2f5 100644 --- a/cpukit/include/rtems/score/watchdog.h +++ b/cpukit/include/rtems/score/watchdog.h @@ -37,7 +37,7 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief Watchdog Handler + * @brief This group contains the Watchdog Handler implementation. * * This handler encapsulates functionality related to the scheduling of * watchdog functions to be called at specific times in the future. diff --git a/cpukit/include/rtems/score/wkspace.h b/cpukit/include/rtems/score/wkspace.h index 92f29bb4b3..1c969d3895 100644 --- a/cpukit/include/rtems/score/wkspace.h +++ b/cpukit/include/rtems/score/wkspace.h @@ -35,8 +35,10 @@ extern "C" { * * @ingroup RTEMSScore * - * This handler encapsulates functionality related to the management of - * the RTEMS Executive Workspace. + * @brief This group contains the Workspace Handler implementation. + * + * This handler encapsulates functionality related to the management of the + * RTEMS Workspace. * * @{ */ -- cgit v1.2.3