diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-11-27 17:21:23 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-12-02 07:45:53 +0100 |
| commit | 9278f3d04f1e26071cb98a5e2940177abc40b6d8 (patch) | |
| tree | 9f5d198e4af5ad22b96012a17ce0a23769acf01f | |
| parent | rtems: Canonicalize Doxygen @file comments (diff) | |
| download | rtems-9278f3d04f1e26071cb98a5e2940177abc40b6d8.tar.bz2 | |
score: Canonicalize Doxygen @file comments
Use common phrases for the file brief descriptions.
Update #3706.
Diffstat (limited to '')
347 files changed, 1618 insertions, 655 deletions
diff --git a/cpukit/include/rtems/score/address.h b/cpukit/include/rtems/score/address.h index f93fcde7db..f963252172 100644 --- a/cpukit/include/rtems/score/address.h +++ b/cpukit/include/rtems/score/address.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSScoreAddress * - * @brief Information Required to Manipulate Physical Addresses - * - * This include file contains the information required to manipulate - * physical addresses. + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreAddress. */ /* diff --git a/cpukit/include/rtems/score/apimutex.h b/cpukit/include/rtems/score/apimutex.h index 20d57b669f..ea1fe209dd 100644 --- a/cpukit/include/rtems/score/apimutex.h +++ b/cpukit/include/rtems/score/apimutex.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreAPIMutex * - * @brief API Mutex Handler API + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreAPIMutex. */ /* diff --git a/cpukit/include/rtems/score/assert.h b/cpukit/include/rtems/score/assert.h index 8ef9e29b4d..26f677421a 100644 --- a/cpukit/include/rtems/score/assert.h +++ b/cpukit/include/rtems/score/assert.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreAssert * - * @brief Information for the Assert Handler + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreAssert. */ /* diff --git a/cpukit/include/rtems/score/atomic.h b/cpukit/include/rtems/score/atomic.h index 4aa73d0a57..2eb8153f3e 100644 --- a/cpukit/include/rtems/score/atomic.h +++ b/cpukit/include/rtems/score/atomic.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreAtomic * - * @brief Atomic Operations API + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreAtomic. */ /* diff --git a/cpukit/include/rtems/score/chain.h b/cpukit/include/rtems/score/chain.h index fdfa963d07..bdd457228e 100644 --- a/cpukit/include/rtems/score/chain.h +++ b/cpukit/include/rtems/score/chain.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreChain * - * @brief Chain Handler API + * @brief This header file provides interfaces of the + * @ref RTEMSScoreChain which are used by the implementation and the API. */ /* diff --git a/cpukit/include/rtems/score/chainimpl.h b/cpukit/include/rtems/score/chainimpl.h index 2d78c4ec6d..234dd1d74e 100644 --- a/cpukit/include/rtems/score/chainimpl.h +++ b/cpukit/include/rtems/score/chainimpl.h @@ -1,9 +1,10 @@ /** * @file * - * @brief Chain Handler API - * * @ingroup RTEMSScoreChain + * + * @brief This header file provides interfaces of the + * @ref RTEMSScoreChain which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/context.h b/cpukit/include/rtems/score/context.h index b174fa27e6..46e04e9600 100644 --- a/cpukit/include/rtems/score/context.h +++ b/cpukit/include/rtems/score/context.h @@ -3,9 +3,8 @@ * * @ingroup RTEMSScoreContext * - * @brief Information About Each Thread's Context - * - * This include file contains all information about each thread's context. + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreContext. */ /* diff --git a/cpukit/include/rtems/score/copyrt.h b/cpukit/include/rtems/score/copyrt.h index b0916087e9..870d7b6353 100644 --- a/cpukit/include/rtems/score/copyrt.h +++ b/cpukit/include/rtems/score/copyrt.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSSuperCoreCopyright * - * @brief Copyright Notice for RTEMS - * - * This include file contains the copyright notice for RTEMS - * which is included in every binary copy of the executive. + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreCopyright. */ /* diff --git a/cpukit/include/rtems/score/corebarrier.h b/cpukit/include/rtems/score/corebarrier.h index 40ccdec479..60abbd6f8f 100644 --- a/cpukit/include/rtems/score/corebarrier.h +++ b/cpukit/include/rtems/score/corebarrier.h @@ -3,10 +3,9 @@ * * @ingroup RTEMSScoreBarrier * - * @brief Constants and Structures Associated with the Barrier Handler - * - * This include file contains all the constants and structures associated - * with the Barrier Handler. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreBarrier which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/corebarrierimpl.h b/cpukit/include/rtems/score/corebarrierimpl.h index 9e9ddfd81e..c2dfea8f9b 100644 --- a/cpukit/include/rtems/score/corebarrierimpl.h +++ b/cpukit/include/rtems/score/corebarrierimpl.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSScoreBarrier * - * @brief Inlined Routines Associated with the SuperCore Barrier - * - * This include file contains all of the inlined routines associated - * with the SuperCore barrier. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreBarrier which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/coremsg.h b/cpukit/include/rtems/score/coremsg.h index 4034577e96..c4320a11a3 100644 --- a/cpukit/include/rtems/score/coremsg.h +++ b/cpukit/include/rtems/score/coremsg.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSScoreMessageQueue * - * @brief Constants and Structures Associated with the Message Queue Handler. - * - * This include file contains all the constants and structures associated - * with the Message queue Handler. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreMessageQueue which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/coremsgbuffer.h b/cpukit/include/rtems/score/coremsgbuffer.h index 1960facb34..330a480423 100644 --- a/cpukit/include/rtems/score/coremsgbuffer.h +++ b/cpukit/include/rtems/score/coremsgbuffer.h @@ -5,8 +5,9 @@ * * @ingroup RTEMSScoreMessageQueue * - * @brief This header file defines the buffer data structure used by the - * Message Queue Handler. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreMessageQueue which are used by the implementation, the + * @ref RTEMSImplApplConfig, and the API. */ /* diff --git a/cpukit/include/rtems/score/coremsgimpl.h b/cpukit/include/rtems/score/coremsgimpl.h index 0bf5fa52d0..6f6a01bea6 100644 --- a/cpukit/include/rtems/score/coremsgimpl.h +++ b/cpukit/include/rtems/score/coremsgimpl.h @@ -3,10 +3,9 @@ * * @ingroup RTEMSScoreMessageQueue * - * @brief Inlined Routines in the Core Message Handler - * - * This include file contains the static inline implementation of all - * inlined routines in the Core Message Handler. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreMessageQueue which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/coremutex.h b/cpukit/include/rtems/score/coremutex.h index af1eb0136e..2f65d6c8c0 100644 --- a/cpukit/include/rtems/score/coremutex.h +++ b/cpukit/include/rtems/score/coremutex.h @@ -3,12 +3,9 @@ * * @ingroup RTEMSScoreMutex * - * @brief CORE Mutex API - * - * This include file contains all the constants and structures associated with - * the Mutex Handler. A mutex is an enhanced version of the standard Dijkstra - * binary semaphore used to provide synchronization and mutual exclusion - * capabilities. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreMutex which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* @@ -43,7 +40,9 @@ extern "C" { * @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. + * Mutex services used in all of the APIs supported by RTEMS. A mutex is an + * enhanced version of the standard Dijkstra binary semaphore used to provide + * synchronization and mutual exclusion capabilities. * * @{ */ diff --git a/cpukit/include/rtems/score/coremuteximpl.h b/cpukit/include/rtems/score/coremuteximpl.h index e04a91c563..cbc1e720fb 100644 --- a/cpukit/include/rtems/score/coremuteximpl.h +++ b/cpukit/include/rtems/score/coremuteximpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreMutex * - * @brief CORE Mutex Implementation + * @brief This header file provides interfaces of the + * @ref RTEMSScoreMutex which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/corerwlockimpl.h b/cpukit/include/rtems/score/corerwlockimpl.h index 37c0c425b7..b182ebeeeb 100644 --- a/cpukit/include/rtems/score/corerwlockimpl.h +++ b/cpukit/include/rtems/score/corerwlockimpl.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSScoreRWLock * - * @brief Inlined Routines Associated with the SuperCore RWLock - * - * This include file contains all of the inlined routines associated - * with the SuperCore RWLock. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreRWLock which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/coresem.h b/cpukit/include/rtems/score/coresem.h index 84b64eac1a..1d2a1fd91a 100644 --- a/cpukit/include/rtems/score/coresem.h +++ b/cpukit/include/rtems/score/coresem.h @@ -3,12 +3,9 @@ * * @ingroup RTEMSScoreSemaphore * - * @brief Data Associated with the Counting Semaphore Handler - * - * This include file contains all the constants and structures associated - * with the Counting Semaphore Handler. A counting semaphore is the - * standard Dijkstra binary semaphore used to provide synchronization - * and mutual exclusion capabilities. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreSemaphore which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/coresemimpl.h b/cpukit/include/rtems/score/coresemimpl.h index b8beff2a45..00356b80bf 100644 --- a/cpukit/include/rtems/score/coresemimpl.h +++ b/cpukit/include/rtems/score/coresemimpl.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSScoreSemaphore * - * @brief Inlined Routines Associated with the SuperCore Semaphore - * - * This include file contains all of the inlined routines associated - * with the SuperCore semaphore. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreSemaphore which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/cpustdatomic.h b/cpukit/include/rtems/score/cpustdatomic.h index ffdcf68097..5e1319037e 100644 --- a/cpukit/include/rtems/score/cpustdatomic.h +++ b/cpukit/include/rtems/score/cpustdatomic.h @@ -1,7 +1,8 @@ /** * @file * - * @brief Atomic Operations CPU API + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreAtomicCPU. */ /* diff --git a/cpukit/include/rtems/score/freechain.h b/cpukit/include/rtems/score/freechain.h index 76b028fba0..2c0cc1aa06 100644 --- a/cpukit/include/rtems/score/freechain.h +++ b/cpukit/include/rtems/score/freechain.h @@ -3,8 +3,11 @@ * * @ingroup RTEMSScoreFreechain * - * @brief Freechain Handler API + * @brief This header file provides interfaces of the + * @ref RTEMSScoreFreechain which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ + /* * Copyright (c) 2013 Gedare Bloom. * diff --git a/cpukit/include/rtems/score/freechainimpl.h b/cpukit/include/rtems/score/freechainimpl.h index 25660003ff..6c3f1bb6d7 100644 --- a/cpukit/include/rtems/score/freechainimpl.h +++ b/cpukit/include/rtems/score/freechainimpl.h @@ -3,8 +3,10 @@ * * @ingroup RTEMSScoreFreechain * - * @brief Freechain Handler API + * @brief This header file provides interfaces of the + * @ref RTEMSScoreBarrier which are only used by the implementation. */ + /* * Copyright (c) 2013 Gedare Bloom. * diff --git a/cpukit/include/rtems/score/heap.h b/cpukit/include/rtems/score/heap.h index 6426c82881..ccc2f5c0fe 100644 --- a/cpukit/include/rtems/score/heap.h +++ b/cpukit/include/rtems/score/heap.h @@ -3,7 +3,9 @@ * * @ingroup RTEMSScoreHeap * - * @brief Heap Handler API + * @brief This header file provides interfaces of the + * @ref RTEMSScoreHeap which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/heapimpl.h b/cpukit/include/rtems/score/heapimpl.h index d3ee0ff88a..76b9da8d5d 100644 --- a/cpukit/include/rtems/score/heapimpl.h +++ b/cpukit/include/rtems/score/heapimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreHeap * - * @brief Heap Handler Implementation + * @brief This header file provides interfaces of the + * @ref RTEMSScoreBarrier which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/heapinfo.h b/cpukit/include/rtems/score/heapinfo.h index 078cc69364..9bba83cd90 100644 --- a/cpukit/include/rtems/score/heapinfo.h +++ b/cpukit/include/rtems/score/heapinfo.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreHeap * - * @brief Heap Handler Information API + * @brief This header file provides interfaces of the + * @ref RTEMSScoreBarrier which are used by the implementation and the API. */ /* diff --git a/cpukit/include/rtems/score/interr.h b/cpukit/include/rtems/score/interr.h index b3dd992eaf..33e9524b65 100644 --- a/cpukit/include/rtems/score/interr.h +++ b/cpukit/include/rtems/score/interr.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSScoreIntErr * - * @brief Constants and Prototypes Related to the Internal Error Handler - * - * This include file contains constants and prototypes related - * to the Internal Error Handler. + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreIntErr. */ /* diff --git a/cpukit/include/rtems/score/io.h b/cpukit/include/rtems/score/io.h index e125ea0b52..f851d30b8a 100644 --- a/cpukit/include/rtems/score/io.h +++ b/cpukit/include/rtems/score/io.h @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreIO + * + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreIO. + */ + /* * Copyright (c) 2017 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/include/rtems/score/isr.h b/cpukit/include/rtems/score/isr.h index 357648314e..3c6a9f1e2c 100644 --- a/cpukit/include/rtems/score/isr.h +++ b/cpukit/include/rtems/score/isr.h @@ -3,12 +3,8 @@ * * @ingroup RTEMSScoreISR * - * @brief Data Related to the Management of Processor Interrupt Levels - * - * This include file contains all the constants and structures associated - * with the management of processor interrupt levels. This handler - * supports interrupt critical sections, vectoring of user interrupt - * handlers, nesting of interrupts, and manipulating interrupt levels. + * @brief This header file provides the main interfaces of the + * @ref RTEMSScoreISR. */ /* @@ -33,7 +29,9 @@ * @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. + * ISR services used in all of the APIs supported by RTEMS. This handler + * supports interrupt critical sections, vectoring of user interrupt handlers, + * nesting of interrupts, and manipulating interrupt levels. * * The ::_ISR_Nest_level variable is maintained by @ref RTEMSScorePerCPU. * diff --git a/cpukit/include/rtems/score/isrlevel.h b/cpukit/include/rtems/score/isrlevel.h index c42451d010..3981f2c688 100644 --- a/cpukit/include/rtems/score/isrlevel.h +++ b/cpukit/include/rtems/score/isrlevel.h @@ -3,10 +3,10 @@ * * @ingroup RTEMSScoreISR * - * @brief ISR Level Type + * @brief This header file provides the ::ISR_Level related interfaces of the + * @ref RTEMSScoreISR. * - * This include file defines the ISR Level type. It exists to - * simplify include dependencies. It is part of the ISR Handler. + * This header file exists to simplify include dependencies. */ /* diff --git a/cpukit/include/rtems/score/isrlock.h b/cpukit/include/rtems/score/isrlock.h index c9b3eaf42c..d787aba9ae 100644 --- a/cpukit/include/rtems/score/isrlock.h +++ b/cpukit/include/rtems/score/isrlock.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreISRLocks * - * @brief ISR Locks + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreISRLocks. */ /* diff --git a/cpukit/include/rtems/score/memory.h b/cpukit/include/rtems/score/memory.h index d2c610973b..5761402711 100644 --- a/cpukit/include/rtems/score/memory.h +++ b/cpukit/include/rtems/score/memory.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreMemory * - * @brief Memory Handler API + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreMemory. */ /* diff --git a/cpukit/include/rtems/score/mpci.h b/cpukit/include/rtems/score/mpci.h index 25d1effdb5..5fda858b1c 100644 --- a/cpukit/include/rtems/score/mpci.h +++ b/cpukit/include/rtems/score/mpci.h @@ -3,7 +3,9 @@ * * @ingroup RTEMSScoreMPCI * - * @brief MPCI Layer API + * @brief This header file provides interfaces of the + * @ref RTEMSScoreMPCI which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/mpciimpl.h b/cpukit/include/rtems/score/mpciimpl.h index c120bce480..4cede136bd 100644 --- a/cpukit/include/rtems/score/mpciimpl.h +++ b/cpukit/include/rtems/score/mpciimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreMPCI * - * @brief MPCI Layer Implementation + * @brief This header file provides interfaces of the + * @ref RTEMSScoreMPCI which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/mppkt.h b/cpukit/include/rtems/score/mppkt.h index fd7f883117..e571ce22ad 100644 --- a/cpukit/include/rtems/score/mppkt.h +++ b/cpukit/include/rtems/score/mppkt.h @@ -3,13 +3,8 @@ * * @ingroup RTEMSScoreMPPacket * - * @brief Specification for the Packet Handler - * - * This package is the specification for the Packet Handler. - * This handler defines the basic packet and provides - * mechanisms to utilize packets based on this prefix. - * Packets are the fundamental basis for messages passed between - * nodes in an MP system. + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreMPPacket. */ /* @@ -42,7 +37,9 @@ extern "C" { * * This handler encapsulates the primary definition of MPCI packets. This * handler defines the part of the packet that is common to all remote - * operations. + * operations. It defines the basic packet and provides mechanisms to utilize + * packets based on this prefix. Packets are the fundamental basis for + * messages passed between nodes in an MP system. * * @{ */ diff --git a/cpukit/include/rtems/score/mrsp.h b/cpukit/include/rtems/score/mrsp.h index 678a678b14..24464520bc 100644 --- a/cpukit/include/rtems/score/mrsp.h +++ b/cpukit/include/rtems/score/mrsp.h @@ -3,7 +3,9 @@ * * @ingroup RTEMSScoreMRSP * - * @brief Definitions for Multiprocessor Resource Sharing Protocol (MrsP). + * @brief This header file provides interfaces of the + * @ref RTEMSScoreMRSP which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/mrspimpl.h b/cpukit/include/rtems/score/mrspimpl.h index a576bc42dc..be4a934436 100644 --- a/cpukit/include/rtems/score/mrspimpl.h +++ b/cpukit/include/rtems/score/mrspimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreMRSP * - * @brief Definitions for Multiprocessor Resource Sharing Protocol (MrsP) Implementation. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreMRSP which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/muteximpl.h b/cpukit/include/rtems/score/muteximpl.h index aac55faf03..c75a9ab657 100644 --- a/cpukit/include/rtems/score/muteximpl.h +++ b/cpukit/include/rtems/score/muteximpl.h @@ -1,9 +1,10 @@ /** * @file * - * @ingroup RTEMSScoreAPIMutex + * @ingroup RTEMSScoreSyslockMutex * - * @brief Structures for the implementation of mutexes. + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreSyslockMutex. */ /* @@ -25,16 +26,22 @@ #include <rtems/score/threadqimpl.h> +#ifdef __cplusplus +extern "C" { +#endif /* __cplusplus */ + /** - * @addtogroup RTEMSScoreAPIMutex + * @defgroup RTEMSScoreSyslockMutex System Lock Mutex Support + * + * @ingroup RTEMSScore + * + * @brief The System Lock Mutex Support helps to implement directives which use + * data structures compatible with the data structures defined by the Newlib + * provided <sys/lock.h> header file. * * @{ */ -#ifdef __cplusplus -extern "C" { -#endif /* __cplusplus */ - typedef struct { Thread_queue_Syslock_queue Queue; } Mutex_Control; @@ -44,10 +51,10 @@ typedef struct { unsigned int nest_level; } Mutex_recursive_Control; +/** @} */ + #ifdef __cplusplus } #endif /* __cplusplus */ -/** @} */ - #endif /* _RTEMS_SCORE_MUTEXIMPL_H */ diff --git a/cpukit/include/rtems/score/object.h b/cpukit/include/rtems/score/object.h index 561db194c2..28a2140521 100644 --- a/cpukit/include/rtems/score/object.h +++ b/cpukit/include/rtems/score/object.h @@ -3,11 +3,9 @@ * * @ingroup RTEMSScoreObject * - * @brief Constants and Structures Associated with the Object Handler - * - * This include file contains all the constants and structures associated - * with the Object Handler. This Handler provides mechanisms which - * can be used to initialize and manipulate all objects which have ids. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreObject which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* @@ -55,6 +53,9 @@ extern "C" { * * @brief This group contains the Object Handler implementation. * + * This handler provides mechanisms which can be used to initialize and + * manipulate all objects which have identifiers. + * * @{ */ diff --git a/cpukit/include/rtems/score/objectimpl.h b/cpukit/include/rtems/score/objectimpl.h index 32387594f2..fb14d38452 100644 --- a/cpukit/include/rtems/score/objectimpl.h +++ b/cpukit/include/rtems/score/objectimpl.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSScoreObject * - * @brief Inlined Routines in the Object Handler - * - * This include file contains the static inline implementation of all - * of the inlined routines in the Object Handler. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreObject which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/objectmp.h b/cpukit/include/rtems/score/objectmp.h index e9419d7bc0..4f41fefe40 100644 --- a/cpukit/include/rtems/score/objectmp.h +++ b/cpukit/include/rtems/score/objectmp.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSScoreObjectMP * - * @brief Data Associated with the Manipulation of Global RTEMS Objects - * - * This include file contains all the constants and structures associated - * with the manipulation of Global RTEMS Objects. + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreObjectMP. */ /* diff --git a/cpukit/include/rtems/score/onceimpl.h b/cpukit/include/rtems/score/onceimpl.h index f3c298abe2..fcd831ad2b 100644 --- a/cpukit/include/rtems/score/onceimpl.h +++ b/cpukit/include/rtems/score/onceimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreOnce * - * @brief Once API + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreOnce. */ /* diff --git a/cpukit/include/rtems/score/percpu.h b/cpukit/include/rtems/score/percpu.h index d2a904663b..58a89ec7a9 100644 --- a/cpukit/include/rtems/score/percpu.h +++ b/cpukit/include/rtems/score/percpu.h @@ -1,8 +1,10 @@ /** - * @file + * @file * - * This include file defines the per CPU information required - * by RTEMS. + * @ingroup RTEMSScorePerCPU + * + * @brief This header file provides the interfaces of the + * @ref RTEMSScorePerCPU. */ /* diff --git a/cpukit/include/rtems/score/percpudata.h b/cpukit/include/rtems/score/percpudata.h index 7e1f787b7e..cae73a62b0 100644 --- a/cpukit/include/rtems/score/percpudata.h +++ b/cpukit/include/rtems/score/percpudata.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScorePerCPUData * - * @brief This header file provides the Flexible Per-CPU Data API. + * @brief This header file provides the interfaces of the + * @ref RTEMSScorePerCPUData. */ /* diff --git a/cpukit/include/rtems/score/priority.h b/cpukit/include/rtems/score/priority.h index 593543ae00..8d54e1d85f 100644 --- a/cpukit/include/rtems/score/priority.h +++ b/cpukit/include/rtems/score/priority.h @@ -3,7 +3,9 @@ * * @ingroup RTEMSScorePriority * - * @brief Priority Handler API + * @brief This header file provides interfaces of the + * @ref RTEMSScorePriority which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/prioritybitmap.h b/cpukit/include/rtems/score/prioritybitmap.h index 3cc8addc4b..30d96ba4c7 100644 --- a/cpukit/include/rtems/score/prioritybitmap.h +++ b/cpukit/include/rtems/score/prioritybitmap.h @@ -3,10 +3,9 @@ * * @ingroup RTEMSScorePriorityBitmap * - * @brief Manipulation Routines for the Bitmap Priority Queue Implementation - * - * This include file contains all thread priority manipulation routines for - * the bit map priority queue implementation. + * @brief This header file provides interfaces of the + * @ref RTEMSScorePriorityBitmap which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/prioritybitmapimpl.h b/cpukit/include/rtems/score/prioritybitmapimpl.h index 60b58bed70..da55d988ba 100644 --- a/cpukit/include/rtems/score/prioritybitmapimpl.h +++ b/cpukit/include/rtems/score/prioritybitmapimpl.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSScorePriorityBitmap * - * @brief Inlined Routines in the Priority Handler Bit Map Implementation - * - * This file contains the static inline implementation of all inlined - * routines in the Priority Handler bit map implementation + * @brief This header file provides interfaces of the + * @ref RTEMSScorePriorityBitmap which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/priorityimpl.h b/cpukit/include/rtems/score/priorityimpl.h index b33419acdb..1a7f90a065 100644 --- a/cpukit/include/rtems/score/priorityimpl.h +++ b/cpukit/include/rtems/score/priorityimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScorePriority * - * @brief Priority Handler API Implementation. + * @brief This header file provides interfaces of the + * @ref RTEMSScorePriority which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/processormask.h b/cpukit/include/rtems/score/processormask.h index 2509169945..b9eae8b54c 100644 --- a/cpukit/include/rtems/score/processormask.h +++ b/cpukit/include/rtems/score/processormask.h @@ -1,9 +1,10 @@ /** * @file * - * @brief Processor Mask API - * * @ingroup RTEMSScoreProcessorMask + * + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreProcessorMask. */ /* diff --git a/cpukit/include/rtems/score/profiling.h b/cpukit/include/rtems/score/profiling.h index 571a291f6a..20e6a4a027 100644 --- a/cpukit/include/rtems/score/profiling.h +++ b/cpukit/include/rtems/score/profiling.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreProfiling * - * @brief Profiling Support API + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreProfiling. */ /* diff --git a/cpukit/include/rtems/score/protectedheap.h b/cpukit/include/rtems/score/protectedheap.h index da3c697077..8d42fb48b3 100644 --- a/cpukit/include/rtems/score/protectedheap.h +++ b/cpukit/include/rtems/score/protectedheap.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreProtHeap * - * @brief Protected Heap Handler API + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreProtHeap. */ /* diff --git a/cpukit/include/rtems/score/rbtree.h b/cpukit/include/rtems/score/rbtree.h index d023c21610..6b0674eecc 100644 --- a/cpukit/include/rtems/score/rbtree.h +++ b/cpukit/include/rtems/score/rbtree.h @@ -3,10 +3,9 @@ * * @ingroup RTEMSScoreRBTree * - * @brief Constants and Structures Associated with the Red-Black Tree Handler - * - * This include file contains all the constants and structures associated - * with the Red-Black Tree Handler. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreRBTree which are used by the implementation, the + * @ref RTEMSImplApplConfig, and the API. */ /* diff --git a/cpukit/include/rtems/score/rbtreeimpl.h b/cpukit/include/rtems/score/rbtreeimpl.h index 1b5b539bb5..597c24d771 100644 --- a/cpukit/include/rtems/score/rbtreeimpl.h +++ b/cpukit/include/rtems/score/rbtreeimpl.h @@ -3,14 +3,8 @@ * * @ingroup RTEMSScoreRBTree * - * @brief Inlined Routines Associated with Red-Black Trees - * - * This include file contains the bodies of the routines which are - * associated with Red-Black Trees and inlined. - * - * @note The routines in this file are ordered from simple - * to complex. No other RBTree Handler routine is referenced - * unless it has already been defined. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreRBTree which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/scheduler.h b/cpukit/include/rtems/score/scheduler.h index 101ea7a5c1..7a566cf44d 100644 --- a/cpukit/include/rtems/score/scheduler.h +++ b/cpukit/include/rtems/score/scheduler.h @@ -3,10 +3,9 @@ * * @ingroup RTEMSScoreScheduler * - * @brief Constants and Structures Associated with the Scheduler - * - * This include file contains all the constants and structures associated - * with the scheduler. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreScheduler which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/schedulercbs.h b/cpukit/include/rtems/score/schedulercbs.h index d9136d8067..e321923c11 100644 --- a/cpukit/include/rtems/score/schedulercbs.h +++ b/cpukit/include/rtems/score/schedulercbs.h @@ -3,10 +3,9 @@ * * @ingroup RTEMSScoreSchedulerCBS * - * @brief Thread manipulation for the CBS scheduler - * - * This include file contains all the constants and structures associated - * with the manipulation of threads for the CBS scheduler. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreSchedulerCBS which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/schedulercbsimpl.h b/cpukit/include/rtems/score/schedulercbsimpl.h index 7985adb220..2c8a20ea42 100644 --- a/cpukit/include/rtems/score/schedulercbsimpl.h +++ b/cpukit/include/rtems/score/schedulercbsimpl.h @@ -1,9 +1,10 @@ /** * @file * - * @brief CBS Scheduler Implementation - * * @ingroup RTEMSScoreSchedulerCBS + * + * @brief This header file provides interfaces of the + * @ref RTEMSScoreSchedulerCBS which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/scheduleredf.h b/cpukit/include/rtems/score/scheduleredf.h index d4d1787d2b..065b511a14 100644 --- a/cpukit/include/rtems/score/scheduleredf.h +++ b/cpukit/include/rtems/score/scheduleredf.h @@ -3,10 +3,9 @@ * * @ingroup RTEMSScoreSchedulerEDF * - * @brief Data Related to the Manipulation of Threads for the EDF Scheduler - * - * This include file contains all the constants and structures associated - * with the manipulation of threads for the EDF scheduler. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreSchedulerEDF which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/scheduleredfimpl.h b/cpukit/include/rtems/score/scheduleredfimpl.h index f2bec2dfbe..f87102d913 100644 --- a/cpukit/include/rtems/score/scheduleredfimpl.h +++ b/cpukit/include/rtems/score/scheduleredfimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreSchedulerEDF * - * @brief EDF Scheduler Implementation + * @brief This header file provides interfaces of the + * @ref RTEMSScoreSchedulerEDF which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/scheduleredfsmp.h b/cpukit/include/rtems/score/scheduleredfsmp.h index 19b3d0beda..69dcd1ab3f 100644 --- a/cpukit/include/rtems/score/scheduleredfsmp.h +++ b/cpukit/include/rtems/score/scheduleredfsmp.h @@ -1,9 +1,10 @@ /** * @file * - * @brief EDF SMP Scheduler API - * * @ingroup RTEMSScoreSchedulerSMPEDF + * + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreSchedulerSMPEDF. */ /* diff --git a/cpukit/include/rtems/score/schedulerimpl.h b/cpukit/include/rtems/score/schedulerimpl.h index cb3556735c..c545615919 100644 --- a/cpukit/include/rtems/score/schedulerimpl.h +++ b/cpukit/include/rtems/score/schedulerimpl.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSScoreScheduler * - * @brief Inlined Routines Associated with the Manipulation of the Scheduler - * - * This inline file contains all of the inlined routines associated with - * the manipulation of the scheduler. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreScheduler which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/schedulernode.h b/cpukit/include/rtems/score/schedulernode.h index 66033c1331..1dba200dca 100644 --- a/cpukit/include/rtems/score/schedulernode.h +++ b/cpukit/include/rtems/score/schedulernode.h @@ -3,7 +3,9 @@ * * @ingroup RTEMSScoreScheduler * - * @brief Handles Scheduler Nodes. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreScheduler related to scheduler nodes which are used by the + * implementation and the @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/schedulernodeimpl.h b/cpukit/include/rtems/score/schedulernodeimpl.h index 675fb0efda..5d6f795912 100644 --- a/cpukit/include/rtems/score/schedulernodeimpl.h +++ b/cpukit/include/rtems/score/schedulernodeimpl.h @@ -3,7 +3,9 @@ * * @ingroup RTEMSScoreScheduler * - * @brief Scheduler Node Implementation. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreScheduler related to scheduler nodes which are only used by + * the implementation. */ /* diff --git a/cpukit/include/rtems/score/schedulerpriority.h b/cpukit/include/rtems/score/schedulerpriority.h index 74e2d07272..66b976ef8f 100644 --- a/cpukit/include/rtems/score/schedulerpriority.h +++ b/cpukit/include/rtems/score/schedulerpriority.h @@ -3,10 +3,9 @@ * * @ingroup RTEMSScoreSchedulerDPS * - * @brief Thread Manipulation with the Priority-Based Scheduler - * - * This include file contains all the constants and structures associated - * with the manipulation of threads for the priority-based scheduler. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreSchedulerDPS which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/schedulerpriorityaffinitysmp.h b/cpukit/include/rtems/score/schedulerpriorityaffinitysmp.h index 679bf4b9a2..3d5ccaae10 100644 --- a/cpukit/include/rtems/score/schedulerpriorityaffinitysmp.h +++ b/cpukit/include/rtems/score/schedulerpriorityaffinitysmp.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreSchedulerPriorityAffinitySMP * - * @brief Deterministic Priority Affinity SMP Scheduler API + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreSchedulerPriorityAffinitySMP. */ /* diff --git a/cpukit/include/rtems/score/schedulerpriorityimpl.h b/cpukit/include/rtems/score/schedulerpriorityimpl.h index 8046d30ddd..64901d52b7 100644 --- a/cpukit/include/rtems/score/schedulerpriorityimpl.h +++ b/cpukit/include/rtems/score/schedulerpriorityimpl.h @@ -3,11 +3,8 @@ * * @ingroup RTEMSScoreSchedulerDPS * - * @brief Inlined Routines Associated with the Manipulation of the - * Priority-Based Scheduling Structures - * - * This inline file contains all of the inlined routines associated with - * the manipulation of the priority-based scheduling structures. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreSchedulerDPS which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/schedulerprioritysmp.h b/cpukit/include/rtems/score/schedulerprioritysmp.h index 8a3955077b..d6ab6f6fdd 100644 --- a/cpukit/include/rtems/score/schedulerprioritysmp.h +++ b/cpukit/include/rtems/score/schedulerprioritysmp.h @@ -3,7 +3,9 @@ * * @ingroup RTEMSScoreSchedulerPrioritySMP * - * @brief Deterministic Priority SMP Scheduler API + * @brief This header file provides interfaces of the + * @ref RTEMSScoreSchedulerPrioritySMP which are used by the implementation + * and the @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/schedulerprioritysmpimpl.h b/cpukit/include/rtems/score/schedulerprioritysmpimpl.h index 28f59396ff..6e14200840 100644 --- a/cpukit/include/rtems/score/schedulerprioritysmpimpl.h +++ b/cpukit/include/rtems/score/schedulerprioritysmpimpl.h @@ -3,7 +3,9 @@ * * @ingroup RTEMSScoreSchedulerPrioritySMP * - * @brief Deterministic Priority SMP Scheduler API + * @brief This header file provides interfaces of the + * @ref RTEMSScoreSchedulerPrioritySMP which are only used by the + * implementation. */ /* diff --git a/cpukit/include/rtems/score/schedulersimple.h b/cpukit/include/rtems/score/schedulersimple.h index 32c77e2d59..e201890f21 100644 --- a/cpukit/include/rtems/score/schedulersimple.h +++ b/cpukit/include/rtems/score/schedulersimple.h @@ -3,10 +3,9 @@ * * @ingroup RTEMSScoreSchedulerSimple * - * @brief Manipulation of Threads Simple-Priority-Based Ready Queue - * - * This include file contains all the constants and structures associated - * with the manipulation of threads on a simple-priority-based ready queue. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreSchedulerSimple which are used by the implementation and + * the @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/schedulersimpleimpl.h b/cpukit/include/rtems/score/schedulersimpleimpl.h index 64cff7df1e..08ad7b8c66 100644 --- a/cpukit/include/rtems/score/schedulersimpleimpl.h +++ b/cpukit/include/rtems/score/schedulersimpleimpl.h @@ -3,11 +3,8 @@ * * @ingroup RTEMSScoreSchedulerSimple * - * @brief Inlined Routines Associated with the Manipulation of the - * Priority-Based Scheduling Structures - * - * This inline file contains all of the inlined routines associated with - * the manipulation of the priority-based scheduling structures. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreSchedulerSimple which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/schedulersimplesmp.h b/cpukit/include/rtems/score/schedulersimplesmp.h index a7e0b82f4a..6b7e111208 100644 --- a/cpukit/include/rtems/score/schedulersimplesmp.h +++ b/cpukit/include/rtems/score/schedulersimplesmp.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreSchedulerSMPSimple * - * @brief Simple SMP Scheduler API + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreSchedulerSMPSimple. */ /* diff --git a/cpukit/include/rtems/score/schedulersmp.h b/cpukit/include/rtems/score/schedulersmp.h index 464124c4ed..1d5294b4f0 100644 --- a/cpukit/include/rtems/score/schedulersmp.h +++ b/cpukit/include/rtems/score/schedulersmp.h @@ -3,7 +3,9 @@ * * @ingroup RTEMSScoreSchedulerSMP * - * @brief SMP Scheduler API + * @brief This header file provides interfaces of the + * @ref RTEMSScoreSchedulerSMP which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/schedulersmpimpl.h b/cpukit/include/rtems/score/schedulersmpimpl.h index b341622ea4..dbfc241b18 100644 --- a/cpukit/include/rtems/score/schedulersmpimpl.h +++ b/cpukit/include/rtems/score/schedulersmpimpl.h @@ -1,9 +1,10 @@ /** * @file * - * @brief SMP Scheduler Implementation - * * @ingroup RTEMSScoreSchedulerSMP + * + * @brief This header file provides interfaces of the + * @ref RTEMSScoreSchedulerSMP which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/schedulerstrongapa.h b/cpukit/include/rtems/score/schedulerstrongapa.h index 7387981454..530eadc279 100644 --- a/cpukit/include/rtems/score/schedulerstrongapa.h +++ b/cpukit/include/rtems/score/schedulerstrongapa.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreSchedulerStrongAPA * - * @brief Strong APA Scheduler API + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreSchedulerStrongAPA. */ /* diff --git a/cpukit/include/rtems/score/semaphoreimpl.h b/cpukit/include/rtems/score/semaphoreimpl.h index bc961eea08..05bf9b20ee 100644 --- a/cpukit/include/rtems/score/semaphoreimpl.h +++ b/cpukit/include/rtems/score/semaphoreimpl.h @@ -1,9 +1,10 @@ /** * @file * - * @ingroup RTEMSScoreSemaphore + * @ingroup RTEMSScoreSyslockSemaphore * - * @brief Semaphore Implementation + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreSyslockSemaphore. */ /* @@ -29,7 +30,13 @@ #include <rtems/score/threadqimpl.h> /** - * @addtogroup RTEMSScoreSemaphore + * @defgroup RTEMSScoreSyslockSemaphore System Lock Semaphore Support + * + * @ingroup RTEMSScore + * + * @brief The System Lock Semaphore Support helps to implement directives which + * use data structures compatible with the data structures defined by the + * Newlib provided <sys/lock.h> header file. * * @{ */ diff --git a/cpukit/include/rtems/score/smp.h b/cpukit/include/rtems/score/smp.h index e4f0149f6b..bd9cfaa5a6 100644 --- a/cpukit/include/rtems/score/smp.h +++ b/cpukit/include/rtems/score/smp.h @@ -3,7 +3,9 @@ * * @ingroup RTEMSScoreSMP * - * @brief SuperCore SMP Support API + * @brief This header file provides interfaces of the + * @ref RTEMSScoreSMP which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/smpbarrier.h b/cpukit/include/rtems/score/smpbarrier.h index cacde6438a..3d66003fd3 100644 --- a/cpukit/include/rtems/score/smpbarrier.h +++ b/cpukit/include/rtems/score/smpbarrier.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreSMPBarrier * - * @brief SMP Barrier API + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreSMPBarrier. */ /* diff --git a/cpukit/include/rtems/score/smpimpl.h b/cpukit/include/rtems/score/smpimpl.h index a341d0d720..ddc2df6b11 100644 --- a/cpukit/include/rtems/score/smpimpl.h +++ b/cpukit/include/rtems/score/smpimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreSMP * - * @brief SuperCore SMP Implementation + * @brief This header file provides interfaces of the + * @ref RTEMSScoreSMP which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/smplock.h b/cpukit/include/rtems/score/smplock.h index b59832d59e..5290358834 100644 --- a/cpukit/include/rtems/score/smplock.h +++ b/cpukit/include/rtems/score/smplock.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreSMPLock * - * @brief SMP Lock API + * @brief This header file provides the main interfaces of the + * @ref RTEMSScoreSMPLock. */ /* diff --git a/cpukit/include/rtems/score/smplockmcs.h b/cpukit/include/rtems/score/smplockmcs.h index 9c003fde6e..512be44dda 100644 --- a/cpukit/include/rtems/score/smplockmcs.h +++ b/cpukit/include/rtems/score/smplockmcs.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreSMPLock * - * @brief SMP Lock API + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreSMPLock related to MCS locks. */ /* diff --git a/cpukit/include/rtems/score/smplockseq.h b/cpukit/include/rtems/score/smplockseq.h index ab07a04351..c64d128320 100644 --- a/cpukit/include/rtems/score/smplockseq.h +++ b/cpukit/include/rtems/score/smplockseq.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreSMPLock * - * @brief SMP Lock API + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreSMPLock related to sequence locks. */ /* diff --git a/cpukit/include/rtems/score/smplockstats.h b/cpukit/include/rtems/score/smplockstats.h index d46c049262..5ff47ec01e 100644 --- a/cpukit/include/rtems/score/smplockstats.h +++ b/cpukit/include/rtems/score/smplockstats.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreSMPLock * - * @brief SMP Lock API + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreSMPLock related to lock statistics. */ /* diff --git a/cpukit/include/rtems/score/smplockticket.h b/cpukit/include/rtems/score/smplockticket.h index 7d0cc368ee..4d2c4da372 100644 --- a/cpukit/include/rtems/score/smplockticket.h +++ b/cpukit/include/rtems/score/smplockticket.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreSMPLock * - * @brief SMP Lock API + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreSMPLock related to ticket locks. */ /* diff --git a/cpukit/include/rtems/score/stack.h b/cpukit/include/rtems/score/stack.h index 9751a12aa5..23421cf7ae 100644 --- a/cpukit/include/rtems/score/stack.h +++ b/cpukit/include/rtems/score/stack.h @@ -3,11 +3,9 @@ * * @ingroup RTEMSScoreStack * - * @brief Information About the Thread Stack Handler - * - * This include file contains all information about the thread - * Stack Handler. This Handler provides mechanisms which can be used to - * initialize and utilize stacks. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreStack which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* @@ -36,7 +34,8 @@ extern "C" { * @brief This group contains the Stack Handler implementation. * * This handler encapsulates functionality which is used in the management - * of thread stacks. + * of thread stacks. It provides mechanisms which can be used to initialize + * and utilize stacks. * * @{ */ diff --git a/cpukit/include/rtems/score/stackimpl.h b/cpukit/include/rtems/score/stackimpl.h index df9f87d5a3..4b014e334d 100644 --- a/cpukit/include/rtems/score/stackimpl.h +++ b/cpukit/include/rtems/score/stackimpl.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSScoreStack * - * @brief Inlined Routines from the Stack Handler - * - * This file contains the static inline implementation of the inlined - * routines from the Stack Handler. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreStack which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/states.h b/cpukit/include/rtems/score/states.h index 6e9d60cb74..6d996f3649 100644 --- a/cpukit/include/rtems/score/states.h +++ b/cpukit/include/rtems/score/states.h @@ -3,9 +3,9 @@ * * @ingroup RTEMSScoreStates * - * @brief Thread Execution State Information - * - * This include file defines thread execution state information. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreStates which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/statesimpl.h b/cpukit/include/rtems/score/statesimpl.h index 9df9ba390d..a3178b298c 100644 --- a/cpukit/include/rtems/score/statesimpl.h +++ b/cpukit/include/rtems/score/statesimpl.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSScoreStates * - * @brief Inlined Routines Associated with Thread State Information - * - * This file contains the static inline implementation of the inlined - * routines associated with thread state information. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreStates which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/status.h b/cpukit/include/rtems/score/status.h index 820ce5ffa1..352f76e34d 100644 --- a/cpukit/include/rtems/score/status.h +++ b/cpukit/include/rtems/score/status.h @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreStatus + * + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreStatus. + */ + /* * Copyright (c) 2016 embedded brains GmbH. All rights reserved. * @@ -25,6 +34,16 @@ extern "C" { #endif /* __cplusplus */ /** + * @defgroup RTEMSScoreStatus Operation Status Support + * + * @ingroup RTEMSScore + * + * @brief This group contains the Operation Status Support implementation. + * + * @{ + */ + +/** * @brief Status code parts for the Classic API. * * Must be in synchronization with rtems_status_code. @@ -133,6 +152,8 @@ typedef enum { STATUS_BUILD( STATUS_CLASSIC_UNSATISFIED, EAGAIN ) } Status_Control; +/** @} */ + #ifdef __cplusplus } #endif /* __cplusplus */ diff --git a/cpukit/include/rtems/score/sysstate.h b/cpukit/include/rtems/score/sysstate.h index 907dfcff0c..59affe7432 100644 --- a/cpukit/include/rtems/score/sysstate.h +++ b/cpukit/include/rtems/score/sysstate.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreSysState * - * @brief System State Handler API + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreSysState. */ /* diff --git a/cpukit/include/rtems/score/thread.h b/cpukit/include/rtems/score/thread.h index b1bc208127..8785879184 100644 --- a/cpukit/include/rtems/score/thread.h +++ b/cpukit/include/rtems/score/thread.h @@ -3,10 +3,9 @@ * * @ingroup RTEMSScoreThread * - * @brief Constants and Structures Related with the Thread Control Block - * - * This include file contains all constants and structures associated - * with the thread control block. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreThread which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/threaddispatch.h b/cpukit/include/rtems/score/threaddispatch.h index 016a9ae9a3..707b449771 100644 --- a/cpukit/include/rtems/score/threaddispatch.h +++ b/cpukit/include/rtems/score/threaddispatch.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreThread * - * @brief Constants and Structures Related with Thread Dispatch + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreThread related to thread dispatching. */ /* diff --git a/cpukit/include/rtems/score/threadimpl.h b/cpukit/include/rtems/score/threadimpl.h index 9468d64df0..52945b407c 100644 --- a/cpukit/include/rtems/score/threadimpl.h +++ b/cpukit/include/rtems/score/threadimpl.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSScoreThread * - * @brief Inlined Routines from the Thread Handler - * - * This file contains the macro implementation of the inlined - * routines from the Thread handler. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreThread which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/threadmp.h b/cpukit/include/rtems/score/threadmp.h index 3fc9d141fd..ae973ef0d8 100644 --- a/cpukit/include/rtems/score/threadmp.h +++ b/cpukit/include/rtems/score/threadmp.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSScoreThreadMP * - * @brief Multiprocessing Portion of the Thread Package - * - * This include file contains the specification for all routines - * and data specific to the multiprocessing portion of the thread package. + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreThreadMP. */ /* diff --git a/cpukit/include/rtems/score/threadq.h b/cpukit/include/rtems/score/threadq.h index 7864905344..de7ca8391b 100644 --- a/cpukit/include/rtems/score/threadq.h +++ b/cpukit/include/rtems/score/threadq.h @@ -3,10 +3,9 @@ * * @ingroup RTEMSScoreThreadQueue * - * @brief Constants and Structures Needed to Declare a Thread Queue - * - * This include file contains all the constants and structures - * needed to declare a thread queue. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreThreadQueue which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/threadqimpl.h b/cpukit/include/rtems/score/threadqimpl.h index 24a2ba5e60..88aba49a68 100644 --- a/cpukit/include/rtems/score/threadqimpl.h +++ b/cpukit/include/rtems/score/threadqimpl.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSScoreThreadQueue * - * @brief Constants and Structures Associated with the Manipulation of Objects - * - * This include file contains all the constants and structures associated - * with the manipulation of objects. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreThreadQueue which are only used by the implementation. */ /* @@ -1078,7 +1076,11 @@ void _Thread_queue_Extract( Thread_Control *the_thread ); * * This routine extracts the_thread from the_thread_queue * and ensures that if there is a proxy for this task on - * another node, it is also dealt with. + * another node, it is also dealt with. A proxy is a data + * data that is on the thread queue on the remote node and + * acts as a proxy for the local thread. If the local thread + * was waiting on a remote operation, then the remote side + * of the operation must be cleaned up. * * @param[in, out] the_thread The pointer to a thread control block that * is to be removed diff --git a/cpukit/include/rtems/score/timecounter.h b/cpukit/include/rtems/score/timecounter.h index 02e96d26b1..8185140f9b 100644 --- a/cpukit/include/rtems/score/timecounter.h +++ b/cpukit/include/rtems/score/timecounter.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreTimecounter * - * @brief Timecounter API + * @brief This header file provides interfaces of the + * @ref RTEMSScoreTimecounter which are used by the implementation and the API. */ /* diff --git a/cpukit/include/rtems/score/timecounterimpl.h b/cpukit/include/rtems/score/timecounterimpl.h index f6522b2de0..ab5cd82bf6 100644 --- a/cpukit/include/rtems/score/timecounterimpl.h +++ b/cpukit/include/rtems/score/timecounterimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreTimecounter * - * @brief Timecounter Implementation + * @brief This header file provides interfaces of the + * @ref RTEMSScoreTimecounter which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/timespec.h b/cpukit/include/rtems/score/timespec.h index 98eb89fe6e..314d804f7d 100644 --- a/cpukit/include/rtems/score/timespec.h +++ b/cpukit/include/rtems/score/timespec.h @@ -3,7 +3,8 @@ * * @ingroup Timespec * - * @brief Contains Helpers for Manipulating Timespecs. + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreTimespec. */ /* diff --git a/cpukit/include/rtems/score/timestamp.h b/cpukit/include/rtems/score/timestamp.h index 3283d2449a..512c26a147 100644 --- a/cpukit/include/rtems/score/timestamp.h +++ b/cpukit/include/rtems/score/timestamp.h @@ -3,9 +3,9 @@ * * @ingroup RTEMSScoreTimestamp * - * @brief Helpers for Manipulating Timestamps - * - * This include file contains helpers for manipulating timestamps. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreTimestamp which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/timestampimpl.h b/cpukit/include/rtems/score/timestampimpl.h index 11e675c7ca..eafd1145c0 100644 --- a/cpukit/include/rtems/score/timestampimpl.h +++ b/cpukit/include/rtems/score/timestampimpl.h @@ -3,9 +3,8 @@ * * @ingroup RTEMSScoreTimestamp * - * @brief Helpers for Manipulating Timestamps - * - * This include file contains helpers for manipulating timestamps. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreTimestamp which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/tls.h b/cpukit/include/rtems/score/tls.h index 5a0ae0633e..a32b7164b5 100644 --- a/cpukit/include/rtems/score/tls.h +++ b/cpukit/include/rtems/score/tls.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreTLS * - * @brief Thread-Local Storage (TLS) + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreTLS. */ /* diff --git a/cpukit/include/rtems/score/todimpl.h b/cpukit/include/rtems/score/todimpl.h index 6d3a97ccf9..9805ec0dfd 100644 --- a/cpukit/include/rtems/score/todimpl.h +++ b/cpukit/include/rtems/score/todimpl.h @@ -2,8 +2,10 @@ * @file * * @ingroup RTEMSScoreTOD + * @ingroup RTEMSScoreTODHooks * - * @brief Time of Day Handler API + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreTOD and the @ref RTEMSScoreTODHooks. */ /* diff --git a/cpukit/include/rtems/score/userext.h b/cpukit/include/rtems/score/userext.h index 6775d6115b..28b90a06ad 100644 --- a/cpukit/include/rtems/score/userext.h +++ b/cpukit/include/rtems/score/userext.h @@ -3,7 +3,9 @@ * * @ingroup RTEMSScoreUserExt * - * @brief User Extension Handler API + * @brief This header file provides interfaces of the + * @ref RTEMSScoreUserExt which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/userextimpl.h b/cpukit/include/rtems/score/userextimpl.h index 23ee957724..fd075a94ec 100644 --- a/cpukit/include/rtems/score/userextimpl.h +++ b/cpukit/include/rtems/score/userextimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreUserExt * - * @brief User Extension Handler API + * @brief This header file provides interfaces of the + * @ref RTEMSScoreUserExt which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/watchdog.h b/cpukit/include/rtems/score/watchdog.h index 7e8727f2f5..8e946866f6 100644 --- a/cpukit/include/rtems/score/watchdog.h +++ b/cpukit/include/rtems/score/watchdog.h @@ -3,11 +3,9 @@ * * @ingroup RTEMSScoreWatchdog * - * @brief Constants and Structures Associated with Watchdog Timers - * - * This include file contains all the constants and structures associated - * with watchdog timers. This Handler provides mechanisms which can be - * used to initialize and manipulate watchdog timers. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreWatchdog which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* @@ -40,7 +38,9 @@ extern "C" { * @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. + * watchdog functions to be called at specific times in the future. It + * provides mechanisms which can be used to initialize and manipulate watchdog + * timers. * * @note This handler does not have anything to do with hardware watchdog * timers. diff --git a/cpukit/include/rtems/score/watchdogimpl.h b/cpukit/include/rtems/score/watchdogimpl.h index a52fb1c2cb..4fdb56d038 100644 --- a/cpukit/include/rtems/score/watchdogimpl.h +++ b/cpukit/include/rtems/score/watchdogimpl.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSScoreWatchdog * - * @brief Inlined Routines in the Watchdog Handler - * - * This file contains the static inline implementation of all inlined - * routines in the Watchdog Handler. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreWatchdog which are only used by the implementation. */ /* diff --git a/cpukit/include/rtems/score/watchdogticks.h b/cpukit/include/rtems/score/watchdogticks.h index ea2651954c..a4f952406e 100644 --- a/cpukit/include/rtems/score/watchdogticks.h +++ b/cpukit/include/rtems/score/watchdogticks.h @@ -3,7 +3,9 @@ * * @ingroup RTEMSScoreWatchdog * - * @brief Constants for the watchdog ticks. + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreWatchdog related to watchdog ticks which are used by the + * implementation and the @ref RTEMSImplApplConfig. */ /* diff --git a/cpukit/include/rtems/score/wkspace.h b/cpukit/include/rtems/score/wkspace.h index 1c969d3895..b37f257ed6 100644 --- a/cpukit/include/rtems/score/wkspace.h +++ b/cpukit/include/rtems/score/wkspace.h @@ -3,11 +3,8 @@ * * @ingroup RTEMSScoreWorkspace * - * @brief Information Related to the RAM Workspace - * - * This include file contains information related to the - * RAM Workspace. This Handler provides mechanisms which can be used to - * define, initialize and manipulate the workspace. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreWorkspace which are only used by the implementation. */ /* @@ -38,7 +35,8 @@ extern "C" { * @brief This group contains the Workspace Handler implementation. * * This handler encapsulates functionality related to the management of the - * RTEMS Workspace. + * RTEMS Workspace. It provides mechanisms which can be used to define, + * initialize and manipulate the RTEMS Workspace. * * @{ */ diff --git a/cpukit/score/src/allocatormutex.c b/cpukit/score/src/allocatormutex.c index 3d2b7fa01e..bf4f88da52 100644 --- a/cpukit/score/src/allocatormutex.c +++ b/cpukit/score/src/allocatormutex.c @@ -1,3 +1,13 @@ +/** + * @file + * + * @ingroup RTEMSScoreAPIMutex + * + * @brief This source file contains the implementation of + * _RTEMS_Lock_allocator(), _RTEMS_Unlock_allocator(), and + * _RTEMS_Allocator_is_owner(). + */ + /* * Copyright (c) 2017 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/apimutexisowner.c b/cpukit/score/src/apimutexisowner.c index 83c8f6fc5d..10a100b55c 100644 --- a/cpukit/score/src/apimutexisowner.c +++ b/cpukit/score/src/apimutexisowner.c @@ -2,6 +2,9 @@ * @file * * @ingroup RTEMSScoreAPIMutex + * + * @brief This source file contains the implementation of + * _API_Mutex_Is_owner(). */ /* diff --git a/cpukit/score/src/apimutexlock.c b/cpukit/score/src/apimutexlock.c index dadd9615c8..50edbe1688 100644 --- a/cpukit/score/src/apimutexlock.c +++ b/cpukit/score/src/apimutexlock.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Acquires the specified API mutex. - * * @ingroup RTEMSScoreAPIMutex + * + * @brief This source file contains the implementation of + * _API_Mutex_Lock(). */ /* diff --git a/cpukit/score/src/apimutexunlock.c b/cpukit/score/src/apimutexunlock.c index 21d1d75771..c0631f05c1 100644 --- a/cpukit/score/src/apimutexunlock.c +++ b/cpukit/score/src/apimutexunlock.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Releases the Specified API Mutex - * * @ingroup RTEMSScoreAPIMutex + * + * @brief This source file contains the implementation of + * _API_Mutex_Unlock(). */ /* diff --git a/cpukit/score/src/chain.c b/cpukit/score/src/chain.c index 47aa4a894f..a92c60fc49 100644 --- a/cpukit/score/src/chain.c +++ b/cpukit/score/src/chain.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Initialize a Chain Header - * * @ingroup RTEMSScoreChain + * + * @brief This source file contains the implementation of + * _Chain_Initialize(). */ /* diff --git a/cpukit/score/src/chainnodecount.c b/cpukit/score/src/chainnodecount.c index 9f0bb38a28..0cd9f32e88 100644 --- a/cpukit/score/src/chainnodecount.c +++ b/cpukit/score/src/chainnodecount.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup RTEMSScoreChain + * + * @brief This source file contains the implementation of + * _Chain_Node_count_unprotected(). + */ /* * Copyright (c) 2012 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/condition.c b/cpukit/score/src/condition.c index 67d133feed..acc72fc1a6 100644 --- a/cpukit/score/src/condition.c +++ b/cpukit/score/src/condition.c @@ -1,3 +1,15 @@ +/** + * @file + * + * @ingroup RTEMSScore + * + * @brief This source file contains the implementation of + * _Condition_Wait(), _Condition_Wait_timed(), _Condition_Wait_recursive(), + * _Condition_Wait_recursive_timed(), + * _Condition_Wait_recursive_timed_ticks(), _Condition_Signal(), and + * _Condition_Broadcast(). + */ + /* * Copyright (c) 2015, 2016 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/configstackspacesize.c b/cpukit/score/src/configstackspacesize.c index aca40640cf..ce3d7d4836 100644 --- a/cpukit/score/src/configstackspacesize.c +++ b/cpukit/score/src/configstackspacesize.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup RTEMSScore + * + * @brief This source file contains the implementation of + * rtems_configuration_get_stack_space_size(). + */ /* * SPDX-License-Identifier: BSD-2-Clause * diff --git a/cpukit/score/src/corebarrier.c b/cpukit/score/src/corebarrier.c index 28329b47f9..c9c9b04ed5 100644 --- a/cpukit/score/src/corebarrier.c +++ b/cpukit/score/src/corebarrier.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Initialize CORE Barrier - * @ingroup RTEMSScoreBarrier + * @ingroup RTEMSScoreBarrier + * + * @brief This source file contains the implementation of + * _CORE_barrier_Initialize(). */ /* diff --git a/cpukit/score/src/corebarrierrelease.c b/cpukit/score/src/corebarrierrelease.c index a2e68862b3..5d510107d6 100644 --- a/cpukit/score/src/corebarrierrelease.c +++ b/cpukit/score/src/corebarrierrelease.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Manually releases the Barrier - * * @ingroup RTEMSScoreBarrier + * + * @brief This source file contains the implementation of + * _CORE_barrier_Do_flush(). */ /* diff --git a/cpukit/score/src/corebarrierwait.c b/cpukit/score/src/corebarrierwait.c index f45873ccb8..3da9b05953 100644 --- a/cpukit/score/src/corebarrierwait.c +++ b/cpukit/score/src/corebarrierwait.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Wait For The Barrier - * @ingroup RTEMSScoreBarrier + * @ingroup RTEMSScoreBarrier + * + * @brief This source file contains the implementation of + * _CORE_barrier_Seize(). */ /* diff --git a/cpukit/score/src/coremsg.c b/cpukit/score/src/coremsg.c index 967ce2355a..cf7f44ed17 100644 --- a/cpukit/score/src/coremsg.c +++ b/cpukit/score/src/coremsg.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Initialize a Message Queue - * @ingroup RTEMSScoreMessageQueue + * @ingroup RTEMSScoreMessageQueue + * + * @brief This source file contains the implementation of + * _CORE_message_queue_Initialize(). */ /* diff --git a/cpukit/score/src/coremsgbroadcast.c b/cpukit/score/src/coremsgbroadcast.c index d5c368d274..f119d49275 100644 --- a/cpukit/score/src/coremsgbroadcast.c +++ b/cpukit/score/src/coremsgbroadcast.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Broadcast a Message to the Message Queue - * @ingroup RTEMSScoreMessageQueue + * @ingroup RTEMSScoreMessageQueue + * + * @brief This source file contains the implementation of + * _CORE_message_queue_Broadcast(). */ /* diff --git a/cpukit/score/src/coremsgclose.c b/cpukit/score/src/coremsgclose.c index 98032dd3ad..1610d8166b 100644 --- a/cpukit/score/src/coremsgclose.c +++ b/cpukit/score/src/coremsgclose.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Close a Message Queue - * @ingroup RTEMSScoreMessageQueue + * @ingroup RTEMSScoreMessageQueue + * + * @brief This source file contains the implementation of + * _CORE_message_queue_Close(). */ /* diff --git a/cpukit/score/src/coremsgflush.c b/cpukit/score/src/coremsgflush.c index 11b40b2e2b..7330cdfe3d 100644 --- a/cpukit/score/src/coremsgflush.c +++ b/cpukit/score/src/coremsgflush.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Flush Messages Routine - * * @ingroup RTEMSScoreMessageQueue + * + * @brief This source file contains the implementation of + * _CORE_message_queue_Flush(). */ /* diff --git a/cpukit/score/src/coremsgflushwait.c b/cpukit/score/src/coremsgflushwait.c index 03804ae335..c343147895 100644 --- a/cpukit/score/src/coremsgflushwait.c +++ b/cpukit/score/src/coremsgflushwait.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Flush Waiting Threads. - * * @ingroup RTEMSScoreMessageQueue + * + * @brief This source file contains the implementation of + * _CORE_message_queue_Flush_waiting_threads(). */ /* diff --git a/cpukit/score/src/coremsginsert.c b/cpukit/score/src/coremsginsert.c index 1a2abc3c96..14b023d9e1 100644 --- a/cpukit/score/src/coremsginsert.c +++ b/cpukit/score/src/coremsginsert.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreMessageQueue * - * @brief Insert a Message into the Message Queue + * @brief This source file contains the implementation of + * _CORE_message_queue_Insert_message(). */ /* diff --git a/cpukit/score/src/coremsgseize.c b/cpukit/score/src/coremsgseize.c index b2b9dbabdb..e44538ee17 100644 --- a/cpukit/score/src/coremsgseize.c +++ b/cpukit/score/src/coremsgseize.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Seize a Message from the Message Queue - * @ingroup RTEMSScoreMessageQueue + * @ingroup RTEMSScoreMessageQueue + * + * @brief This source file contains the implementation of + * _CORE_message_queue_Seize(). */ /* diff --git a/cpukit/score/src/coremsgsubmit.c b/cpukit/score/src/coremsgsubmit.c index 77fe30c0dd..fda000cc86 100644 --- a/cpukit/score/src/coremsgsubmit.c +++ b/cpukit/score/src/coremsgsubmit.c @@ -1,9 +1,10 @@ /** * @file * - * @brief CORE Message Queue Submit - * * @ingroup RTEMSScoreMessageQueue + * + * @brief This source file contains the implementation of + * _CORE_message_queue_Submit(). */ /* diff --git a/cpukit/score/src/coremutexseize.c b/cpukit/score/src/coremutexseize.c index 5998935f29..77f13b3774 100644 --- a/cpukit/score/src/coremutexseize.c +++ b/cpukit/score/src/coremutexseize.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Seize Mutex with Blocking - * @ingroup RTEMSScoreMutex + * @ingroup RTEMSScoreMutex + * + * @brief This source file contains the implementation of + * _CORE_mutex_Seize_slow(). */ /* diff --git a/cpukit/score/src/corerwlock.c b/cpukit/score/src/corerwlock.c index 068a412861..516b696c91 100644 --- a/cpukit/score/src/corerwlock.c +++ b/cpukit/score/src/corerwlock.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreRWLock * - * @brief + * @brief This source file contains the implementation of + * _CORE_RWLock_Initialize(). */ /* diff --git a/cpukit/score/src/corerwlockobtainread.c b/cpukit/score/src/corerwlockobtainread.c index ee74c3dc6d..2d084b1639 100644 --- a/cpukit/score/src/corerwlockobtainread.c +++ b/cpukit/score/src/corerwlockobtainread.c @@ -1,9 +1,10 @@ /** * @file - * + * * @ingroup RTEMSScoreRWLock * - * @brief Obtain RWLock for reading + * @brief This source file contains the implementation of + * _CORE_RWLock_Seize_for_reading(). */ /* diff --git a/cpukit/score/src/corerwlockobtainwrite.c b/cpukit/score/src/corerwlockobtainwrite.c index ea0cdabcdc..4f1dbf5bd1 100644 --- a/cpukit/score/src/corerwlockobtainwrite.c +++ b/cpukit/score/src/corerwlockobtainwrite.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreRWLock * - * @brief RWLock Obtain for Writing + * @brief This source file contains the implementation of + * _CORE_RWLock_Seize_for_writing(). */ /* diff --git a/cpukit/score/src/corerwlockrelease.c b/cpukit/score/src/corerwlockrelease.c index d79456872a..c309b31e8b 100644 --- a/cpukit/score/src/corerwlockrelease.c +++ b/cpukit/score/src/corerwlockrelease.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Releases the RWLock - * * @ingroup RTEMSScoreRWLock + * + * @brief This source file contains the implementation of + * _CORE_RWLock_Surrender(). */ /* diff --git a/cpukit/score/src/coresem.c b/cpukit/score/src/coresem.c index 8f56da994f..f80e6d686a 100644 --- a/cpukit/score/src/coresem.c +++ b/cpukit/score/src/coresem.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Core Semaphore Initialize - * @ingroup RTEMSScoreSemaphore + * @ingroup RTEMSScoreSemaphore + * + * @brief This source file contains the implementation of + * _CORE_semaphore_Initialize(). */ /* diff --git a/cpukit/score/src/coretod.c b/cpukit/score/src/coretod.c index d402bb438d..2258714ad9 100644 --- a/cpukit/score/src/coretod.c +++ b/cpukit/score/src/coretod.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Initializes the Time of Day Handler - * * @ingroup RTEMSScoreTOD + * + * @brief This source file contains the definition of ::_TOD and the + * implementation of _TOD_Lock(), _TOD_Unlock(), and _TOD_Is_owner(). */ /* COPYRIGHT (c) 1989-2014. diff --git a/cpukit/score/src/coretodadjust.c b/cpukit/score/src/coretodadjust.c index e58d1e5d69..a746b0e004 100644 --- a/cpukit/score/src/coretodadjust.c +++ b/cpukit/score/src/coretodadjust.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreTOD * - * @brief Adjust the Time of Time + * @brief This source file contains the implementation of + * _TOD_Adjust(). */ /* diff --git a/cpukit/score/src/coretodhookdata.c b/cpukit/score/src/coretodhookdata.c index c26b2ab813..299f59ef04 100644 --- a/cpukit/score/src/coretodhookdata.c +++ b/cpukit/score/src/coretodhookdata.c @@ -1,14 +1,15 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + /** * @file * - * @brief TOD Hook Set - * * @ingroup RTEMSScoreTODHooks + * + * @brief This source file contains the definition of + * ::_TOD_Hooks. */ /* - * SPDX-License-Identifier: BSD-2-Clause - * * COPYRIGHT (c) 2019. * On-Line Applications Research Corporation (OAR). * @@ -40,6 +41,5 @@ #include <rtems/score/todimpl.h> #include <rtems/score/chainimpl.h> - -Chain_Control _TOD_Hooks = CHAIN_INITIALIZER_EMPTY(_TOD_Hooks); +Chain_Control _TOD_Hooks = CHAIN_INITIALIZER_EMPTY( _TOD_Hooks ); diff --git a/cpukit/score/src/coretodhookregister.c b/cpukit/score/src/coretodhookregister.c index 794f3a1d1f..dbd3ddd22f 100644 --- a/cpukit/score/src/coretodhookregister.c +++ b/cpukit/score/src/coretodhookregister.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Register Hook to be in TOD Hook Set - * * @ingroup RTEMSScoreTODHooks + * + * @brief This source file contains the implementation of + * _TOD_Hook_Register(). */ /* @@ -40,7 +41,7 @@ #include <rtems/score/todimpl.h> #include <rtems/score/chainimpl.h> - + void _TOD_Hook_Register( TOD_Hook *hook ) @@ -48,7 +49,7 @@ void _TOD_Hook_Register( /* * At this time, this method does NOT have a Classic or POSIX API * that exports it. Any use of this method will be a direct call. - * It should only be called while NOT holding the TOD lock. + * It should only be called while NOT holding the TOD lock. */ _Assert( !_TOD_Is_owner() ); diff --git a/cpukit/score/src/coretodhookrun.c b/cpukit/score/src/coretodhookrun.c index 10d3c57748..bf7d88efa9 100644 --- a/cpukit/score/src/coretodhookrun.c +++ b/cpukit/score/src/coretodhookrun.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Run TOD Hook Set - * * @ingroup RTEMSScoreTODHooks + * + * @brief This source file contains the implementation of + * _TOD_Hook_Run(). */ /* diff --git a/cpukit/score/src/coretodhookunregister.c b/cpukit/score/src/coretodhookunregister.c index 72b11a158a..5adb8b4c3f 100644 --- a/cpukit/score/src/coretodhookunregister.c +++ b/cpukit/score/src/coretodhookunregister.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Remove Hook from TOD Hook Set - * * @ingroup RTEMSScoreTODHooks + * + * @brief This source file contains the implementation of + * _TOD_Hook_Unregister(). */ /* @@ -40,7 +41,7 @@ #include <rtems/score/todimpl.h> #include <rtems/score/chainimpl.h> - + void _TOD_Hook_Unregister( TOD_Hook *hook ) @@ -48,7 +49,7 @@ void _TOD_Hook_Unregister( /* * At this time, this method does NOT have a Classic or POSIX API * that exports it. Any use of this method will be a direct call. - * It should only be called while NOT holding the TOD lock. + * It should only be called while NOT holding the TOD lock. */ _Assert( !_TOD_Is_owner() ); diff --git a/cpukit/score/src/coretodset.c b/cpukit/score/src/coretodset.c index 8d09af0ebd..5fc01215e0 100644 --- a/cpukit/score/src/coretodset.c +++ b/cpukit/score/src/coretodset.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Set Time of Day Given a Timestamp - * * @ingroup RTEMSScoreTOD + * + * @brief This source file contains the implementation of + * _TOD_Set(). */ /* COPYRIGHT (c) 1989-2007. diff --git a/cpukit/score/src/coretodtickspersec.c b/cpukit/score/src/coretodtickspersec.c index 107614c730..f4860975bc 100644 --- a/cpukit/score/src/coretodtickspersec.c +++ b/cpukit/score/src/coretodtickspersec.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreTOD * - * @brief Convert Ticks To Seconds + * @brief This source file contains the implementation of + * TOD_TICKS_PER_SECOND_method(). */ /* COPYRIGHT (c) 1989-2014. diff --git a/cpukit/score/src/debugisthreaddispatchingallowed.c b/cpukit/score/src/debugisthreaddispatchingallowed.c index e75c462ab5..7cb93b55f9 100644 --- a/cpukit/score/src/debugisthreaddispatchingallowed.c +++ b/cpukit/score/src/debugisthreaddispatchingallowed.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup RTEMSScore + * + * @brief This source file contains the implementation of + * _Debug_Is_thread_dispatching_allowed(). + */ /* * Copyright (c) 2013-2014 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/freechain.c b/cpukit/score/src/freechain.c index e5b1f84a63..7756b86cec 100644 --- a/cpukit/score/src/freechain.c +++ b/cpukit/score/src/freechain.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreFreechain * - * @brief Freechain Handler Implementation + * @brief This source file contains the implementation of + * _Freechain_Extend(), _Freechain_Get(), and _Freechain_Put(). */ /* diff --git a/cpukit/score/src/futex.c b/cpukit/score/src/futex.c index de430a87ae..b65a843704 100644 --- a/cpukit/score/src/futex.c +++ b/cpukit/score/src/futex.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup RTEMSScore + * + * @brief This source file contains the implementation of + * _Futex_Wait() and _Futex_Wake(). + */ /* * Copyright (c) 2015, 2016 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/heap.c b/cpukit/score/src/heap.c index 429e8cdd9a..ca36f4a384 100644 --- a/cpukit/score/src/heap.c +++ b/cpukit/score/src/heap.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreHeap * - * @brief Heap Handler implementation. + * @brief This source file contains the implementation of + * _Heap_Initialize() and _Heap_Block_allocate(). */ /* diff --git a/cpukit/score/src/heapallocate.c b/cpukit/score/src/heapallocate.c index 4b8b3f0de6..663f7ac775 100644 --- a/cpukit/score/src/heapallocate.c +++ b/cpukit/score/src/heapallocate.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreHeap * - * @brief Heap Handler implementation. + * @brief This source file contains the implementation of + * _Heap_Allocate_aligned_with_boundary(). */ /* diff --git a/cpukit/score/src/heapextend.c b/cpukit/score/src/heapextend.c index 4c6166fba2..332bf1edec 100644 --- a/cpukit/score/src/heapextend.c +++ b/cpukit/score/src/heapextend.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreHeap * - * @brief Heap Handler implementation. + * @brief This source file contains the implementation of + * _Heap_Extend(). */ /* diff --git a/cpukit/score/src/heapfree.c b/cpukit/score/src/heapfree.c index 086cfe72d2..d2ab5d4d1d 100644 --- a/cpukit/score/src/heapfree.c +++ b/cpukit/score/src/heapfree.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreHeap * - * @brief Heap Handler implementation. + * @brief This source file contains the implementation of + * _Heap_Free(). */ /* diff --git a/cpukit/score/src/heapgetfreeinfo.c b/cpukit/score/src/heapgetfreeinfo.c index 2fed4d7c1b..a72ba1572c 100644 --- a/cpukit/score/src/heapgetfreeinfo.c +++ b/cpukit/score/src/heapgetfreeinfo.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreHeap * - * @brief Heap Handler implementation. + * @brief This source file contains the implementation of + * _Heap_Get_free_information(). */ /* diff --git a/cpukit/score/src/heapgetinfo.c b/cpukit/score/src/heapgetinfo.c index 2928e210fa..9388664276 100644 --- a/cpukit/score/src/heapgetinfo.c +++ b/cpukit/score/src/heapgetinfo.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreHeap * - * @brief Heap Handler implementation. + * @brief This source file contains the implementation of + * _Heap_Get_information(). */ /* diff --git a/cpukit/score/src/heapgreedy.c b/cpukit/score/src/heapgreedy.c index 980459ff46..dfb77a715b 100644 --- a/cpukit/score/src/heapgreedy.c +++ b/cpukit/score/src/heapgreedy.c @@ -3,7 +3,9 @@ * * @ingroup RTEMSScoreHeap * - * @brief Heap Handler API. + * @brief This source file contains the implementation of + * _Heap_Greedy_allocate(), _Heap_Greedy_allocate_all_except_largest(), and + * _Heap_Greedy_free(). */ /* diff --git a/cpukit/score/src/heapiterate.c b/cpukit/score/src/heapiterate.c index 22db510b4a..bf3f5416d4 100644 --- a/cpukit/score/src/heapiterate.c +++ b/cpukit/score/src/heapiterate.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreHeap * - * @brief _Heap_Iterate() implementation. + * @brief This source file contains the implementation of + * _Heap_Iterate(). */ /* diff --git a/cpukit/score/src/heapnoextend.c b/cpukit/score/src/heapnoextend.c index 1788420e1c..99952e690c 100644 --- a/cpukit/score/src/heapnoextend.c +++ b/cpukit/score/src/heapnoextend.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreHeap * - * @brief Heap Handler implementation. + * @brief This source file contains the implementation of + * _Heap_No_extend(). */ /* diff --git a/cpukit/score/src/heapresizeblock.c b/cpukit/score/src/heapresizeblock.c index c0e1daa112..62d0b64b6b 100644 --- a/cpukit/score/src/heapresizeblock.c +++ b/cpukit/score/src/heapresizeblock.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreHeap * - * @brief Heap Handler implementation. + * @brief This source file contains the implementation of + * _Heap_Resize_block(). */ /* diff --git a/cpukit/score/src/heapsizeofuserarea.c b/cpukit/score/src/heapsizeofuserarea.c index 4f17073494..7a12ab53c8 100644 --- a/cpukit/score/src/heapsizeofuserarea.c +++ b/cpukit/score/src/heapsizeofuserarea.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreHeap * - * @brief Heap Handler implementation. + * @brief This source file contains the implementation of + * _Heap_Size_of_alloc_area(). */ /* diff --git a/cpukit/score/src/heapwalk.c b/cpukit/score/src/heapwalk.c index 50458437ee..dbcd0d4cd5 100644 --- a/cpukit/score/src/heapwalk.c +++ b/cpukit/score/src/heapwalk.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreHeap * - * @brief Heap Handler implementation. + * @brief This source file contains the implementation of + * _Heap_Walk(). */ /* diff --git a/cpukit/score/src/interr.c b/cpukit/score/src/interr.c index f59f352ba2..3f5ec2c473 100644 --- a/cpukit/score/src/interr.c +++ b/cpukit/score/src/interr.c @@ -3,7 +3,9 @@ * * @ingroup RTEMSScoreIntErr * - * @brief Initiates system termination + * @brief This source file contains the definition of ::_System_state_Current + * and ::_Internal_errors_What_happened and implementation of _Terminate() and + * _Internal_error(). */ /* diff --git a/cpukit/score/src/iobase64.c b/cpukit/score/src/iobase64.c index ab0498438d..bbf7658c2a 100644 --- a/cpukit/score/src/iobase64.c +++ b/cpukit/score/src/iobase64.c @@ -1,5 +1,14 @@ /* SPDX-License-Identifier: ISC */ +/** + * @file + * + * @ingroup RTEMSScoreIO + * + * @brief This source file contains the implementation of + * _IO_Base64(). + */ + /* * Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) * Copyright (C) 2004, 2005, 2007, 2009 Internet Systems Consortium, Inc. ("ISC") diff --git a/cpukit/score/src/ioprintf.c b/cpukit/score/src/ioprintf.c index 2fe65f41d0..107ffd94c4 100644 --- a/cpukit/score/src/ioprintf.c +++ b/cpukit/score/src/ioprintf.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreIO + * + * @brief This source file contains the implementation of + * _IO_Printf(). + */ + /* * Copyright (c) 2017 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/iovprintf.c b/cpukit/score/src/iovprintf.c index f3f8219261..0e8eb0b47b 100644 --- a/cpukit/score/src/iovprintf.c +++ b/cpukit/score/src/iovprintf.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreIO + * + * @brief This source file contains the implementation of + * _IO_Vprintf(). + */ + /*- * SPDX-License-Identifier: BSD-3-Clause * diff --git a/cpukit/score/src/isr.c b/cpukit/score/src/isr.c index 826ad44df4..519532b283 100644 --- a/cpukit/score/src/isr.c +++ b/cpukit/score/src/isr.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Initialize the ISR handler - * @ingroup RTEMSScoreISR + * @ingroup RTEMSScoreISR + * + * @brief This source file contains the definition of ::_ISR_Vector_table and + * the implementation of _ISR_Handler_initialization(). */ /* diff --git a/cpukit/score/src/isrisinprogress.c b/cpukit/score/src/isrisinprogress.c index 52d6779800..eb7bbea8e4 100644 --- a/cpukit/score/src/isrisinprogress.c +++ b/cpukit/score/src/isrisinprogress.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreISR * - * @brief ISR Is In Progress Default Implementation + * @brief This source file contains the default implementation of + * _ISR_Is_in_progress(). */ /* diff --git a/cpukit/score/src/iterateoverthreads.c b/cpukit/score/src/iterateoverthreads.c index 97c50538b8..05b03ac0ac 100644 --- a/cpukit/score/src/iterateoverthreads.c +++ b/cpukit/score/src/iterateoverthreads.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Iterates Over All Threads - * @ingroup RTEMSScoreThread + * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * rtems_iterate_over_all_threads(). */ /* diff --git a/cpukit/score/src/kern_tc.c b/cpukit/score/src/kern_tc.c index 1b65cf41ee..a93cfaeff0 100644 --- a/cpukit/score/src/kern_tc.c +++ b/cpukit/score/src/kern_tc.c @@ -1,3 +1,20 @@ +/** + * @file + * + * @ingroup RTEMSScoreTimecounter + * + * @brief This source file contains the definition of + * ::_Timecounter, ::_Timecounter_Time_second, and ::_Timecounter_Time_uptime + * and the implementation of _Timecounter_Binuptime(), + * _Timecounter_Nanouptime(), _Timecounter_Microuptime(), + * _Timecounter_Bintime(), _Timecounter_Nanotime(), _Timecounter_Microtime(), + * _Timecounter_Getbinuptime(), _Timecounter_Getnanouptime(), + * _Timecounter_Getmicrouptime(), _Timecounter_Getbintime(), + * _Timecounter_Getnanotime(), _Timecounter_Getmicrotime(), + * _Timecounter_Getboottime(), _Timecounter_Getboottimebin(), and + * _Timecounter_Install(). + */ + /*- * ---------------------------------------------------------------------------- * "THE BEER-WARE LICENSE" (Revision 42): diff --git a/cpukit/score/src/libatomic.c b/cpukit/score/src/libatomic.c index 9151ecc906..13113db583 100644 --- a/cpukit/score/src/libatomic.c +++ b/cpukit/score/src/libatomic.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreAtomic + * + * @brief This source file contains the implementation of + * _Libatomic_Protect_start() and _Libatomic_Protect_end(). + */ + /* * Copyright (c) 2016 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/log2table.c b/cpukit/score/src/log2table.c index 58353678be..0a4e37ad79 100644 --- a/cpukit/score/src/log2table.c +++ b/cpukit/score/src/log2table.c @@ -1,9 +1,10 @@ -/* +/** * @file * - * @brief Priority Bit Map Implementation - * * @ingroup RTEMSScorePriorityBitmap + * + * @brief This source file contains the definition of + * ::_Bitfield_Leading_zeros. */ /* diff --git a/cpukit/score/src/memoryallocate.c b/cpukit/score/src/memoryallocate.c index dc87fda96f..e2aed7aa1d 100644 --- a/cpukit/score/src/memoryallocate.c +++ b/cpukit/score/src/memoryallocate.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreMemory + * + * @brief This source file contains the implementation of + * _Memory_Allocate(). + */ + /* * SPDX-License-Identifier: BSD-2-Clause * diff --git a/cpukit/score/src/memorydirtyfreeareas.c b/cpukit/score/src/memorydirtyfreeareas.c index d77d21e913..fc6c2630bf 100644 --- a/cpukit/score/src/memorydirtyfreeareas.c +++ b/cpukit/score/src/memorydirtyfreeareas.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreMemory + * + * @brief This source file contains the implementation of + * _Memory_Dirty_free_areas(). + */ + /* * SPDX-License-Identifier: BSD-2-Clause * diff --git a/cpukit/score/src/memoryfill.c b/cpukit/score/src/memoryfill.c index 1899c6903b..617bf6911e 100644 --- a/cpukit/score/src/memoryfill.c +++ b/cpukit/score/src/memoryfill.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreMemory + * + * @brief This source file contains the implementation of + * _Memory_Fill(). + */ + /* * SPDX-License-Identifier: BSD-2-Clause * diff --git a/cpukit/score/src/memoryzerobeforeuse.c b/cpukit/score/src/memoryzerobeforeuse.c index c9057cfc23..9143cd9c7d 100644 --- a/cpukit/score/src/memoryzerobeforeuse.c +++ b/cpukit/score/src/memoryzerobeforeuse.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreMemory + * + * @brief This source file contains the definition of + * ::_Memory_Zero_before_use. + */ + /* * SPDX-License-Identifier: BSD-2-Clause * diff --git a/cpukit/score/src/memoryzerofreeareas.c b/cpukit/score/src/memoryzerofreeareas.c index a8602d11b8..4ea0812426 100644 --- a/cpukit/score/src/memoryzerofreeareas.c +++ b/cpukit/score/src/memoryzerofreeareas.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreMemory + * + * @brief This source file contains the implementation of + * _Memory_Zero_free_areas(). + */ + /* * SPDX-License-Identifier: BSD-2-Clause * diff --git a/cpukit/score/src/mpci.c b/cpukit/score/src/mpci.c index dff2338ed6..a18155351a 100644 --- a/cpukit/score/src/mpci.c +++ b/cpukit/score/src/mpci.c @@ -3,7 +3,18 @@ * * @ingroup RTEMSScoreMPCI * - * @brief Multiprocessing Communications Interface (MPCI) Handler + * @brief This source file contains the definition of + * ::_System_state_Is_multiprocessing, ::_MPCI_Semaphore, + * ::_MPCI_Remote_blocked_threads, ::_MPCI_table, ::_MPCI_Receive_server_tcb, + * ::_MPCI_Packet_processors and the implementation of + * _MPCI_Register_packet_processor(), _MPCI_Get_packet(), + * _MPCI_Send_process_packet(), _MPCI_Send_request_packet(), + * _MPCI_Send_response_packet(), _MPCI_Receive_packet(), + * _MPCI_Process_response(), _MPCI_Receive_server(), _MPCI_Announce(), + * _MPCI_Internal_packets_Send_process_packet(), + * _MPCI_Internal_packets_Process_packet(), + * _MPCI_Internal_packets_Get_packet(), and the MPCI Handler system + * initialization. */ /* diff --git a/cpukit/score/src/mpcidefault.c b/cpukit/score/src/mpcidefault.c index ea3e2eaf41..c30ed8d373 100644 --- a/cpukit/score/src/mpcidefault.c +++ b/cpukit/score/src/mpcidefault.c @@ -3,7 +3,10 @@ * * @ingroup RTEMSScoreMPCI * - * @brief Multiprocessing Communications Interface (MPCI) Default Configuration + * @brief This source file contains a definition of + * ::_Objects_MP_Controls, ::_Thread_MP_Proxies, and + * ::_MPCI_Receive_server_stack for an application configuration with only + * the local MPCI node and no MP objects. */ /* diff --git a/cpukit/score/src/mutex.c b/cpukit/score/src/mutex.c index 0499719ba6..88a390f323 100644 --- a/cpukit/score/src/mutex.c +++ b/cpukit/score/src/mutex.c @@ -1,3 +1,15 @@ +/** + * @file + * + * @ingroup RTEMSScore + * + * @brief This source file contains the implementation of + * _Mutex_Acquire(), _Mutex_Acquire_timed(), _Mutex_Acquire_timed_ticks(), + * _Mutex_Try_acquire(), _Mutex_Release(), _Mutex_recursive_Acquire(), + * _Mutex_recursive_Acquire_timed(), _Mutex_recursive_Try_acquire(), and + * _Mutex_recursive_Release(). + */ + /* * Copyright (c) 2015, 2016 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/objectactivecount.c b/cpukit/score/src/objectactivecount.c index c658fc21e3..a723b692a5 100644 --- a/cpukit/score/src/objectactivecount.c +++ b/cpukit/score/src/objectactivecount.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreObject + * + * @brief This source file contains the implementation of + * _Objects_Active_count(). + */ + /* * Copyright (c) 2012 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/objectallocate.c b/cpukit/score/src/objectallocate.c index e7d587c25e..ba126d2533 100644 --- a/cpukit/score/src/objectallocate.c +++ b/cpukit/score/src/objectallocate.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreObject * - * @brief Allocate Object + * @brief This source file contains the implementation of + * _Objects_Allocate(). */ /* diff --git a/cpukit/score/src/objectallocatenone.c b/cpukit/score/src/objectallocatenone.c index 5ac0991bc5..a1bead5f79 100644 --- a/cpukit/score/src/objectallocatenone.c +++ b/cpukit/score/src/objectallocatenone.c @@ -1,12 +1,15 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + /** * @file * * @ingroup RTEMSScoreObject + * + * @brief This source file contains the implementation of + * _Objects_Allocate_none(). */ /* - * SPDX-License-Identifier: BSD-2-Clause - * * Copyright (C) 2019 embedded brains GmbH * * Redistribution and use in source and binary forms, with or without diff --git a/cpukit/score/src/objectallocatestatic.c b/cpukit/score/src/objectallocatestatic.c index 160c68b23c..0521c8191f 100644 --- a/cpukit/score/src/objectallocatestatic.c +++ b/cpukit/score/src/objectallocatestatic.c @@ -1,12 +1,15 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + /** * @file * * @ingroup RTEMSScoreObject + * + * @brief This source file contains the implementation of + * _Objects_Allocate_static(). */ /* - * SPDX-License-Identifier: BSD-2-Clause - * * Copyright (C) 2019 embedded brains GmbH * * Redistribution and use in source and binary forms, with or without diff --git a/cpukit/score/src/objectallocateunlimited.c b/cpukit/score/src/objectallocateunlimited.c index b975fe5c3b..274a69640b 100644 --- a/cpukit/score/src/objectallocateunlimited.c +++ b/cpukit/score/src/objectallocateunlimited.c @@ -1,12 +1,15 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + /** * @file * * @ingroup RTEMSScoreObject + * + * @brief This source file contains the implementation of + * _Objects_Allocate_unlimited(). */ /* - * SPDX-License-Identifier: BSD-2-Clause - * * Copyright (C) 2020 embedded brains GmbH * * Redistribution and use in source and binary forms, with or without diff --git a/cpukit/score/src/objectapimaximumclass.c b/cpukit/score/src/objectapimaximumclass.c index 0fb87ab772..7a52d787ef 100644 --- a/cpukit/score/src/objectapimaximumclass.c +++ b/cpukit/score/src/objectapimaximumclass.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Object API Maximum Class - * @ingroup RTEMSScoreObject + * @ingroup RTEMSScoreObject + * + * @brief This source file contains the implementation of + * _Objects_API_maximum_class(). */ /* diff --git a/cpukit/score/src/objectclose.c b/cpukit/score/src/objectclose.c index 4fd24198f4..60a1f3864f 100644 --- a/cpukit/score/src/objectclose.c +++ b/cpukit/score/src/objectclose.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Close Object - * @ingroup RTEMSScoreObject + * @ingroup RTEMSScoreObject + * + * @brief This source file contains the implementation of + * _Objects_Close(). */ /* diff --git a/cpukit/score/src/objectextendinformation.c b/cpukit/score/src/objectextendinformation.c index f4c96462bf..9796eb9e56 100644 --- a/cpukit/score/src/objectextendinformation.c +++ b/cpukit/score/src/objectextendinformation.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreObject * - * @brief Extend Set of Objects + * @brief This source file contains the implementation of + * _Objects_Extend_information(). */ /* diff --git a/cpukit/score/src/objectfree.c b/cpukit/score/src/objectfree.c index 1f7aa37e3f..9b631e5b6d 100644 --- a/cpukit/score/src/objectfree.c +++ b/cpukit/score/src/objectfree.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Free Object - * @ingroup RTEMSScoreObject + * @ingroup RTEMSScoreObject + * + * @brief This source file contains the implementation of + * _Objects_Free_unlimited(). */ /* diff --git a/cpukit/score/src/objectfreestatic.c b/cpukit/score/src/objectfreestatic.c index 2a9411bb58..4bdc0e1071 100644 --- a/cpukit/score/src/objectfreestatic.c +++ b/cpukit/score/src/objectfreestatic.c @@ -1,12 +1,15 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + /** * @file * * @ingroup RTEMSScoreObject + * + * @brief This source file contains the implementation of + * _Objects_Free_static(). */ /* - * SPDX-License-Identifier: BSD-2-Clause - * * Copyright (C) 2019 embedded brains GmbH * * Redistribution and use in source and binary forms, with or without diff --git a/cpukit/score/src/objectgetinfo.c b/cpukit/score/src/objectgetinfo.c index b0ca7e2766..07b401faf0 100644 --- a/cpukit/score/src/objectgetinfo.c +++ b/cpukit/score/src/objectgetinfo.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Get Object Information - * @ingroup RTEMSScoreObject + * @ingroup RTEMSScoreObject + * + * @brief This source file contains the implementation of + * _Objects_Get_information(). */ /* diff --git a/cpukit/score/src/objectgetinfoid.c b/cpukit/score/src/objectgetinfoid.c index 99243cc938..b127ef4e47 100644 --- a/cpukit/score/src/objectgetinfoid.c +++ b/cpukit/score/src/objectgetinfoid.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Get Information of an Object from an ID + * @ingroup RTEMSScoreObject * - * @ingroup RTEMSScore + * @brief This source file contains the implementation of + * _Objects_Get_information_id(). */ /* diff --git a/cpukit/score/src/objectgetlocal.c b/cpukit/score/src/objectgetlocal.c index a09f3ebcaf..ac5155c819 100644 --- a/cpukit/score/src/objectgetlocal.c +++ b/cpukit/score/src/objectgetlocal.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Object Get Local - * @ingroup RTEMSScoreObject + * @ingroup RTEMSScoreObject + * + * @brief This source file contains the implementation of + * _Objects_Get(). */ /* diff --git a/cpukit/score/src/objectgetnameasstring.c b/cpukit/score/src/objectgetnameasstring.c index dc0ec9372d..bf6daeb213 100644 --- a/cpukit/score/src/objectgetnameasstring.c +++ b/cpukit/score/src/objectgetnameasstring.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Extracts a Node from a Chain + * @ingroup RTEMSScoreObject * - * @ingroup RTEMSScore + * @brief This source file contains the implementation of + * _Objects_Name_to_string() and _Objects_Get_name_as_string(). */ /* diff --git a/cpukit/score/src/objectgetnext.c b/cpukit/score/src/objectgetnext.c index 841d5aa8e2..7141ca3620 100644 --- a/cpukit/score/src/objectgetnext.c +++ b/cpukit/score/src/objectgetnext.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreObject * - * @brief Get Pointer to Next Object that is Active + * @brief This source file contains the implementation of + * _Objects_Get_next(). */ /* diff --git a/cpukit/score/src/objectgetnoprotection.c b/cpukit/score/src/objectgetnoprotection.c index f084d15382..e6e96bc020 100644 --- a/cpukit/score/src/objectgetnoprotection.c +++ b/cpukit/score/src/objectgetnoprotection.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Get Object without Dispatching Protection - * @ingroup RTEMSScoreObject + * @ingroup RTEMSScoreObject + * + * @brief This source file contains the implementation of + * _Objects_Get_no_protection(). */ /* diff --git a/cpukit/score/src/objectidtoname.c b/cpukit/score/src/objectidtoname.c index a689102c8c..a959636870 100644 --- a/cpukit/score/src/objectidtoname.c +++ b/cpukit/score/src/objectidtoname.c @@ -1,8 +1,10 @@ -/* - * @file +/** + * @file + * + * @ingroup RTEMSScoreObject * - * @brief Object id to name - * @ingroup RTEMSScore + * @brief This source file contains the implementation of + * _Objects_Id_to_name(). */ /* diff --git a/cpukit/score/src/objectinitializeinformation.c b/cpukit/score/src/objectinitializeinformation.c index b2cb85322f..d9e200bfde 100644 --- a/cpukit/score/src/objectinitializeinformation.c +++ b/cpukit/score/src/objectinitializeinformation.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreObject * - * @brief Initialize Object Information + * @brief This source file contains the implementation of + * _Objects_Initialize_information(). */ /* diff --git a/cpukit/score/src/objectmp.c b/cpukit/score/src/objectmp.c index 612fdacca0..b44ef65e94 100644 --- a/cpukit/score/src/objectmp.c +++ b/cpukit/score/src/objectmp.c @@ -1,8 +1,17 @@ /** - * @file + * @file * - * @brief Objects MP Support - * @ingroup RTEMSScoreObjectMP + * @ingroup RTEMSScoreObjectMP + * + * @brief This source file contains the definition of + * ::_Objects_Local_node, ::_Objects_Maximum_nodes, + * ::_Objects_MP_Maximum_global_objects and the implementation of + * _Objects_MP_Handler_early_initialization(), + * _Objects_MP_Handler_initialization(), _Objects_MP_Open(), + * _Objects_MP_Allocate_and_open(), _Objects_MP_Close(), + * _Objects_MP_Global_name_search(), _Objects_MP_Is_remote(), + * _Objects_MP_Allocate_global_object(), and + * _Objects_MP_Free_global_object(). */ /* diff --git a/cpukit/score/src/objectnamespaceremove.c b/cpukit/score/src/objectnamespaceremove.c index 27f48f2460..4cbf34eac0 100644 --- a/cpukit/score/src/objectnamespaceremove.c +++ b/cpukit/score/src/objectnamespaceremove.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Removes Object from Namespace + * @ingroup RTEMSScoreObject * - * @ingroup RTEMSScore + * @brief This source file contains the implementation of + * _Objects_Namespace_remove_string(). */ /* diff --git a/cpukit/score/src/objectnametoid.c b/cpukit/score/src/objectnametoid.c index ba73bdbad6..da5cbabbc4 100644 --- a/cpukit/score/src/objectnametoid.c +++ b/cpukit/score/src/objectnametoid.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Object Name To Id - * @ingroup RTEMSScore + * @ingroup RTEMSScoreObject + * + * @brief This source file contains the implementation of + * _Objects_Name_to_id_u32(). */ /* diff --git a/cpukit/score/src/objectnametoidstring.c b/cpukit/score/src/objectnametoidstring.c index 38054bface..d08652f88a 100644 --- a/cpukit/score/src/objectnametoidstring.c +++ b/cpukit/score/src/objectnametoidstring.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreObject * - * @brief Object ID to Name + * @brief This source file contains the implementation of + * _Objects_Get_by_name(). */ /* diff --git a/cpukit/score/src/objectsetname.c b/cpukit/score/src/objectsetname.c index 0808ab87af..85b49ff13f 100644 --- a/cpukit/score/src/objectsetname.c +++ b/cpukit/score/src/objectsetname.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreObject * - * @brief Set Objects Name + * @brief This source file contains the implementation of + * _Objects_Set_name(). */ /* diff --git a/cpukit/score/src/objectshrinkinformation.c b/cpukit/score/src/objectshrinkinformation.c index 73f91617b5..9c4a71bac6 100644 --- a/cpukit/score/src/objectshrinkinformation.c +++ b/cpukit/score/src/objectshrinkinformation.c @@ -1,7 +1,10 @@ /** * @file * - * @brief Shrink an Object Class Information Record + * @ingroup RTEMSScoreObject + * + * @brief This source file contains the implementation of + * _Objects_Free_objects_block() and _Objects_Shrink_information(). */ /* diff --git a/cpukit/score/src/once.c b/cpukit/score/src/once.c index 2b2cc0e89b..cf576e90ef 100644 --- a/cpukit/score/src/once.c +++ b/cpukit/score/src/once.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreOnce + * + * @brief This source file contains the implementation of + * _Once(), _Once_Lock(), and _Once_Unlock(). + */ + /* * SPDX-License-Identifier: BSD-2-Clause * diff --git a/cpukit/score/src/opt_compat.h b/cpukit/score/src/opt_compat.h index e69de29bb2..b450491bb7 100644 --- a/cpukit/score/src/opt_compat.h +++ b/cpukit/score/src/opt_compat.h @@ -0,0 +1,7 @@ +/** + * @file + * + * @ingroup RTEMSScoreTimecounter + * + * @brief This header file is provided for FreeBSD compatibility. + */ diff --git a/cpukit/score/src/opt_ffclock.h b/cpukit/score/src/opt_ffclock.h index e69de29bb2..b450491bb7 100644 --- a/cpukit/score/src/opt_ffclock.h +++ b/cpukit/score/src/opt_ffclock.h @@ -0,0 +1,7 @@ +/** + * @file + * + * @ingroup RTEMSScoreTimecounter + * + * @brief This header file is provided for FreeBSD compatibility. + */ diff --git a/cpukit/score/src/opt_ntp.h b/cpukit/score/src/opt_ntp.h index e69de29bb2..b450491bb7 100644 --- a/cpukit/score/src/opt_ntp.h +++ b/cpukit/score/src/opt_ntp.h @@ -0,0 +1,7 @@ +/** + * @file + * + * @ingroup RTEMSScoreTimecounter + * + * @brief This header file is provided for FreeBSD compatibility. + */ diff --git a/cpukit/score/src/percpu.c b/cpukit/score/src/percpu.c index 6aebfc2637..e254f306eb 100644 --- a/cpukit/score/src/percpu.c +++ b/cpukit/score/src/percpu.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup PerCPU + * @ingroup RTEMSScorePerCPU * - * @brief Allocate and Initialize Per CPU Structures + * @brief This source file contains a definition of ::_Per_CPU_Information and + * the implementation of _Per_CPU_State_change(). */ /* diff --git a/cpukit/score/src/percpuasm.c b/cpukit/score/src/percpuasm.c index 816e502226..9b0ce86c26 100644 --- a/cpukit/score/src/percpuasm.c +++ b/cpukit/score/src/percpuasm.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScorePerCPU + * + * @brief This source file contains the static assertions for defines used in + * assembler files. + */ + /* * Copyright (c) 2012, 2016 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/percpustatewait.c b/cpukit/score/src/percpustatewait.c index 0c2e0a580c..9d9f590df5 100644 --- a/cpukit/score/src/percpustatewait.c +++ b/cpukit/score/src/percpustatewait.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScorePerCPU + * + * @brief This source file contains the implementation of + * _Per_CPU_State_wait_for_non_initial_state(). + */ + /* * Copyright (c) 2014 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/pheapallocate.c b/cpukit/score/src/pheapallocate.c index 7edbbf9e06..8bf357869c 100644 --- a/cpukit/score/src/pheapallocate.c +++ b/cpukit/score/src/pheapallocate.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreProtHeap * - * @brief Protected Heap Handler implementation. + * @brief This source file contains the implementation of + * _Protected_heap_Allocate_aligned_with_boundary(). */ /* diff --git a/cpukit/score/src/pheapextend.c b/cpukit/score/src/pheapextend.c index 26c94ba625..c7aa11ed3c 100644 --- a/cpukit/score/src/pheapextend.c +++ b/cpukit/score/src/pheapextend.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreProtHeap * - * @brief Protected Heap Handler implementation. + * @brief This source file contains the implementation of + * _Protected_heap_Extend(). */ /* diff --git a/cpukit/score/src/pheapfree.c b/cpukit/score/src/pheapfree.c index 73a51cd7e7..0e4b2b4687 100644 --- a/cpukit/score/src/pheapfree.c +++ b/cpukit/score/src/pheapfree.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreProtHeap * - * @brief Protected Heap Handler implementation. + * @brief This source file contains the implementation of + * _Protected_heap_Free(). */ /* diff --git a/cpukit/score/src/pheapgetblocksize.c b/cpukit/score/src/pheapgetblocksize.c index fc503e6b8d..4ad5e275a6 100644 --- a/cpukit/score/src/pheapgetblocksize.c +++ b/cpukit/score/src/pheapgetblocksize.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreProtHeap * - * @brief Protected Heap Handler implementation. + * @brief This source file contains the implementation of + * _Protected_heap_Get_block_size(). */ /* diff --git a/cpukit/score/src/pheapgetfreeinfo.c b/cpukit/score/src/pheapgetfreeinfo.c index 38e3103c0c..6874db8151 100644 --- a/cpukit/score/src/pheapgetfreeinfo.c +++ b/cpukit/score/src/pheapgetfreeinfo.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreProtHeap * - * @brief Protected Heap Handler implementation. + * @brief This source file contains the implementation of + * _Protected_heap_Get_free_information(). */ /* diff --git a/cpukit/score/src/pheapgetinfo.c b/cpukit/score/src/pheapgetinfo.c index 7dabb77018..407169d54d 100644 --- a/cpukit/score/src/pheapgetinfo.c +++ b/cpukit/score/src/pheapgetinfo.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreProtHeap * - * @brief Protected Heap Handler implementation. + * @brief This source file contains the implementation of + * _Protected_heap_Get_information(). */ /* diff --git a/cpukit/score/src/pheapgetsize.c b/cpukit/score/src/pheapgetsize.c index d8af9f38b7..42f84ae4a6 100644 --- a/cpukit/score/src/pheapgetsize.c +++ b/cpukit/score/src/pheapgetsize.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreProtHeap * - * @brief Protected Heap Handler implementation. + * @brief This source file contains the implementation of + * _Protected_heap_Get_size(). */ /* diff --git a/cpukit/score/src/pheapiterate.c b/cpukit/score/src/pheapiterate.c index 7a766745cf..d30723de21 100644 --- a/cpukit/score/src/pheapiterate.c +++ b/cpukit/score/src/pheapiterate.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreProtHeap * - * @brief _Heap_Iterate() implementation. + * @brief This source file contains the implementation of + * _Protected_heap_Iterate(). */ /* diff --git a/cpukit/score/src/pheapresizeblock.c b/cpukit/score/src/pheapresizeblock.c index ad90e8ca81..ee1198d6a3 100644 --- a/cpukit/score/src/pheapresizeblock.c +++ b/cpukit/score/src/pheapresizeblock.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreProtHeap * - * @brief Protected Heap Handler implementation. + * @brief This source file contains the implementation of + * _Protected_heap_Resize_block(). */ /* diff --git a/cpukit/score/src/pheapwalk.c b/cpukit/score/src/pheapwalk.c index d4a5e0aca9..27ae2adb34 100644 --- a/cpukit/score/src/pheapwalk.c +++ b/cpukit/score/src/pheapwalk.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreProtHeap * - * @brief Protected Heap Handler implementation. + * @brief This source file contains the implementation of + * _Protected_heap_Walk(). */ /* diff --git a/cpukit/score/src/processormaskcopy.c b/cpukit/score/src/processormaskcopy.c index 1e1c5b6ca8..dc1dbeb3f7 100644 --- a/cpukit/score/src/processormaskcopy.c +++ b/cpukit/score/src/processormaskcopy.c @@ -1,9 +1,11 @@ /** * @file * - * @brief Processor Mask Implementation - * * @ingroup RTEMSScoreProcessorMask + * + * @brief This source file contains the definition of + * ::_Processor_mask_The_one_and_only and the implementation of + * _Processor_mask_Copy(). */ /* diff --git a/cpukit/score/src/profilingisrentryexit.c b/cpukit/score/src/profilingisrentryexit.c index 4a0133b29a..2b846d9964 100644 --- a/cpukit/score/src/profilingisrentryexit.c +++ b/cpukit/score/src/profilingisrentryexit.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreProfiling + * + * @brief This source file contains the implementation of + * _Profiling_Outer_most_interrupt_entry_and_exit(). + */ + /* * Copyright (c) 2014, 2016 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/profilingsmplock.c b/cpukit/score/src/profilingsmplock.c index f84c63acde..d5bd482965 100644 --- a/cpukit/score/src/profilingsmplock.c +++ b/cpukit/score/src/profilingsmplock.c @@ -1,3 +1,14 @@ +/** + * @file + * + * @ingroup RTEMSScoreSMPLock + * + * @brief This source file contains the implementation of + * _SMP_lock_Stats_destroy(), _SMP_lock_Stats_register_or_max_section_time(), + * _SMP_lock_Stats_iteration_start(), _SMP_lock_Stats_iteration_next(), and + * _SMP_lock_Stats_iteration_stop(). + */ + /* * Copyright (c) 2014, 2018 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/rbtreeextract.c b/cpukit/score/src/rbtreeextract.c index 270e60d96a..0bed12ad80 100644 --- a/cpukit/score/src/rbtreeextract.c +++ b/cpukit/score/src/rbtreeextract.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreRBTree + * + * @brief This source file contains the implementation of + * _RBTree_Extract(). + */ + /* * Copyright (c) 2010 Gedare Bloom. * diff --git a/cpukit/score/src/rbtreeinsert.c b/cpukit/score/src/rbtreeinsert.c index d9532d63d6..324cf3ba06 100644 --- a/cpukit/score/src/rbtreeinsert.c +++ b/cpukit/score/src/rbtreeinsert.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreRBTree + * + * @brief This source file contains the implementation of + * _RBTree_Insert_color(). + */ + /* * Copyright (c) 2010-2012 Gedare Bloom. * diff --git a/cpukit/score/src/rbtreeiterate.c b/cpukit/score/src/rbtreeiterate.c index c4c8180af2..715a3d37cb 100644 --- a/cpukit/score/src/rbtreeiterate.c +++ b/cpukit/score/src/rbtreeiterate.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreRBTree * - * @brief _RBTree_Iterate() implementation. + * @brief This source file contains the implementation of + * _RBTree_Iterate(). */ /* diff --git a/cpukit/score/src/rbtreenext.c b/cpukit/score/src/rbtreenext.c index d0720a29c6..32087955fe 100644 --- a/cpukit/score/src/rbtreenext.c +++ b/cpukit/score/src/rbtreenext.c @@ -3,7 +3,9 @@ * * @ingroup RTEMSScoreRBTree * - * @brief _RBTree_Next() and _RBTree_Next() implementation. + * @brief This source file contains the implementation of + * _RBTree_Minimum(), _RBTree_Maximum(), _RBTree_Successor(), and + * _RBTree_Predecessor(). */ /* diff --git a/cpukit/score/src/rbtreepostorder.c b/cpukit/score/src/rbtreepostorder.c index efe992b1fa..1f97ed457f 100644 --- a/cpukit/score/src/rbtreepostorder.c +++ b/cpukit/score/src/rbtreepostorder.c @@ -3,8 +3,8 @@ * * @ingroup RTEMSScoreRBTree * - * @brief _RBTree_Postorder_first() and _RBTree_Postorder_next() - * implementation. + * @brief This source file contains the implementation of + * _RBTree_Postorder_next() and _RBTree_Postorder_first(). */ /* diff --git a/cpukit/score/src/rbtreereplace.c b/cpukit/score/src/rbtreereplace.c index c8408667f9..641485f222 100644 --- a/cpukit/score/src/rbtreereplace.c +++ b/cpukit/score/src/rbtreereplace.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreRBTree * - * @brief _RBTree_Replace_node() implementation. + * @brief This source file contains the implementation of + * _RBTree_Replace_node(). */ /* diff --git a/cpukit/score/src/sched.c b/cpukit/score/src/sched.c index 893e50bba3..63636ff9c1 100644 --- a/cpukit/score/src/sched.c +++ b/cpukit/score/src/sched.c @@ -1,3 +1,13 @@ +/** + * @file + * + * @ingroup RTEMSScoreScheduler + * + * @brief This source file contains the implementation of + * _Sched_Count(), _Sched_Index(), _Sched_Name_to_index(), and + * _Sched_Processor_count(). + */ + /* * Copyright (c) 2015 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/scheduler.c b/cpukit/score/src/scheduler.c index 45c0496838..0b7a5a1a9f 100644 --- a/cpukit/score/src/scheduler.c +++ b/cpukit/score/src/scheduler.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreScheduler * - * @brief Scheduler Initialize + * @brief This source file contains the implementation of + * _Scheduler_Handler_initialization(). */ /* diff --git a/cpukit/score/src/schedulercbs.c b/cpukit/score/src/schedulercbs.c index 12a7a76251..8e5bf86f27 100644 --- a/cpukit/score/src/schedulercbs.c +++ b/cpukit/score/src/schedulercbs.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerCBS * - * @brief CBS Scheduler Budget Handler + * @brief This source file contains the implementation of + * _Scheduler_CBS_Budget_callout() and _Scheduler_CBS_Initialize(). */ /* diff --git a/cpukit/score/src/schedulercbsattachthread.c b/cpukit/score/src/schedulercbsattachthread.c index ec941a30b7..0cb59fa2e8 100644 --- a/cpukit/score/src/schedulercbsattachthread.c +++ b/cpukit/score/src/schedulercbsattachthread.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Attach Scheduler CBS Thread - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerCBS + * + * @brief This source file contains the implementation of + * _Scheduler_CBS_Attach_thread(). */ /* diff --git a/cpukit/score/src/schedulercbscleanup.c b/cpukit/score/src/schedulercbscleanup.c index 9ed9df4b21..aeedd02395 100644 --- a/cpukit/score/src/schedulercbscleanup.c +++ b/cpukit/score/src/schedulercbscleanup.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Scheduler CBS Cleanup - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerCBS + * + * @brief This source file contains the implementation of + * _Scheduler_CBS_Cleanup(). */ /* diff --git a/cpukit/score/src/schedulercbscreateserver.c b/cpukit/score/src/schedulercbscreateserver.c index 5ee83467e7..8e07954e2a 100644 --- a/cpukit/score/src/schedulercbscreateserver.c +++ b/cpukit/score/src/schedulercbscreateserver.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Scheduler CBS Create Server - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerCBS + * + * @brief This source file contains the implementation of + * _Scheduler_CBS_Create_server(). */ /* diff --git a/cpukit/score/src/schedulercbsdestroyserver.c b/cpukit/score/src/schedulercbsdestroyserver.c index 11baf8328d..d536e711d8 100644 --- a/cpukit/score/src/schedulercbsdestroyserver.c +++ b/cpukit/score/src/schedulercbsdestroyserver.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Scheduler CBS Destroy Server + * @ingroup RTEMSScoreSchedulerCBS * - * @ingroup RTEMSScoreScheduler + * @brief This source file contains the implementation of + * _Scheduler_CBS_Destroy_server(). */ /* diff --git a/cpukit/score/src/schedulercbsdetachthread.c b/cpukit/score/src/schedulercbsdetachthread.c index 85dfc11be0..687b37804f 100644 --- a/cpukit/score/src/schedulercbsdetachthread.c +++ b/cpukit/score/src/schedulercbsdetachthread.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Detach from the CBS Server + * @ingroup RTEMSScoreSchedulerCBS * - * @ingroup RTEMSScoreScheduler + * @brief This source file contains the implementation of + * _Scheduler_CBS_Detach_thread(). */ /* diff --git a/cpukit/score/src/schedulercbsgetapprovedbudget.c b/cpukit/score/src/schedulercbsgetapprovedbudget.c index 6924afaa35..0c53009ad4 100644 --- a/cpukit/score/src/schedulercbsgetapprovedbudget.c +++ b/cpukit/score/src/schedulercbsgetapprovedbudget.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Scheduler CBS Get Approved Budget - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerCBS + * + * @brief This source file contains the implementation of + * _Scheduler_CBS_Get_approved_budget(). */ /* diff --git a/cpukit/score/src/schedulercbsgetexecutiontime.c b/cpukit/score/src/schedulercbsgetexecutiontime.c index d9b58ff9aa..28709151c0 100644 --- a/cpukit/score/src/schedulercbsgetexecutiontime.c +++ b/cpukit/score/src/schedulercbsgetexecutiontime.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Get Thread Execution Info + * @ingroup RTEMSScoreSchedulerCBS * - * @ingroup RTEMSScoreScheduler + * @brief This source file contains the implementation of + * _Scheduler_CBS_Get_execution_time(). */ /* diff --git a/cpukit/score/src/schedulercbsgetparameters.c b/cpukit/score/src/schedulercbsgetparameters.c index 65e4965176..48c68e7534 100644 --- a/cpukit/score/src/schedulercbsgetparameters.c +++ b/cpukit/score/src/schedulercbsgetparameters.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerCBS * - * @brief _Scheduler_CBS_Get_parameters + * @brief This source file contains the implementation of + * _Scheduler_CBS_Get_parameters(). */ /* diff --git a/cpukit/score/src/schedulercbsgetremainingbudget.c b/cpukit/score/src/schedulercbsgetremainingbudget.c index ca2cd086db..5cb299d67e 100644 --- a/cpukit/score/src/schedulercbsgetremainingbudget.c +++ b/cpukit/score/src/schedulercbsgetremainingbudget.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Scheduler CBS Get Remaining Budget - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerCBS + * + * @brief This source file contains the implementation of + * _Scheduler_CBS_Get_remaining_budget(). */ /* diff --git a/cpukit/score/src/schedulercbsgetserverid.c b/cpukit/score/src/schedulercbsgetserverid.c index b9882c78b5..57e89f1adb 100644 --- a/cpukit/score/src/schedulercbsgetserverid.c +++ b/cpukit/score/src/schedulercbsgetserverid.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Scheduler CBS Get Server id - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerCBS + * + * @brief This source file contains the implementation of + * _Scheduler_CBS_Get_server_id(). */ /* diff --git a/cpukit/score/src/schedulercbsnodeinit.c b/cpukit/score/src/schedulercbsnodeinit.c index 4710def95a..387f5ffbd5 100644 --- a/cpukit/score/src/schedulercbsnodeinit.c +++ b/cpukit/score/src/schedulercbsnodeinit.c @@ -1,8 +1,10 @@ -/* - * @file +/** + * @file + * + * @ingroup RTEMSScoreSchedulerCBS * - * @brief Scheduler CBS Allocate - * @ingroup RTEMSScoreScheduler + * @brief This source file contains the implementation of + * _Scheduler_CBS_Node_initialize(). */ /* diff --git a/cpukit/score/src/schedulercbsreleasejob.c b/cpukit/score/src/schedulercbsreleasejob.c index 291d6ec1fc..376906b996 100644 --- a/cpukit/score/src/schedulercbsreleasejob.c +++ b/cpukit/score/src/schedulercbsreleasejob.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Scheduler CBS Release Job + * @ingroup RTEMSScoreSchedulerCBS * - * @ingroup RTEMSScoreScheduler + * @brief This source file contains the implementation of + * _Scheduler_CBS_Release_job(). */ /* diff --git a/cpukit/score/src/schedulercbssetparameters.c b/cpukit/score/src/schedulercbssetparameters.c index 995c0f503a..00d24785a0 100644 --- a/cpukit/score/src/schedulercbssetparameters.c +++ b/cpukit/score/src/schedulercbssetparameters.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Set Parameters for CBS Scheduling + * @ingroup RTEMSScoreSchedulerCBS * - * @ingroup RTEMSScoreScheduler + * @brief This source file contains the implementation of + * _Scheduler_CBS_Set_parameters(). */ /* diff --git a/cpukit/score/src/schedulercbsunblock.c b/cpukit/score/src/schedulercbsunblock.c index 90bec78f9e..700d7b1202 100644 --- a/cpukit/score/src/schedulercbsunblock.c +++ b/cpukit/score/src/schedulercbsunblock.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Unblocks a Thread from the Queue + * @ingroup RTEMSScoreSchedulerCBS * - * @ingroup RTEMSScoreScheduler + * @brief This source file contains the implementation of + * _Scheduler_CBS_Unblock(). */ /* diff --git a/cpukit/score/src/schedulerdefaultaskforhelp.c b/cpukit/score/src/schedulerdefaultaskforhelp.c index bd172d3d06..17c222eafb 100644 --- a/cpukit/score/src/schedulerdefaultaskforhelp.c +++ b/cpukit/score/src/schedulerdefaultaskforhelp.c @@ -1,3 +1,14 @@ +/** + * @file + * + * @ingroup RTEMSScoreScheduler + * + * @brief This source file contains the implementation of + * _Scheduler_default_Ask_for_help(), + * _Scheduler_default_Reconsider_help_request(), and + * _Scheduler_default_Withdraw_node(). + */ + /* * Copyright (c) 2014, 2016 embedded brains GmbH * diff --git a/cpukit/score/src/schedulerdefaultmappriority.c b/cpukit/score/src/schedulerdefaultmappriority.c index 87d13ff40f..290165d143 100644 --- a/cpukit/score/src/schedulerdefaultmappriority.c +++ b/cpukit/score/src/schedulerdefaultmappriority.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreScheduler + * + * @brief This source file contains the implementation of + * _Scheduler_default_Map_priority() and _Scheduler_default_Unmap_priority(). + */ + /* * Copyright (c) 2016, 2017 embedded brains GmbH * diff --git a/cpukit/score/src/schedulerdefaultnodedestroy.c b/cpukit/score/src/schedulerdefaultnodedestroy.c index 35f5d62f0d..796896d854 100644 --- a/cpukit/score/src/schedulerdefaultnodedestroy.c +++ b/cpukit/score/src/schedulerdefaultnodedestroy.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Scheduler Default Node Destruction Operation - * * @ingroup RTEMSScoreScheduler + * + * @brief This source file contains the implementation of + * _Scheduler_default_Node_destroy(). */ /* diff --git a/cpukit/score/src/schedulerdefaultnodeinit.c b/cpukit/score/src/schedulerdefaultnodeinit.c index f780003480..73fb73d6ac 100644 --- a/cpukit/score/src/schedulerdefaultnodeinit.c +++ b/cpukit/score/src/schedulerdefaultnodeinit.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Scheduler Default Node Initialization Operation - * * @ingroup RTEMSScoreScheduler + * + * @brief This source file contains the implementation of + * _Scheduler_default_Node_initialize(). */ /* diff --git a/cpukit/score/src/schedulerdefaultpinunpin.c b/cpukit/score/src/schedulerdefaultpinunpin.c index 6465791631..4aa2169c8e 100644 --- a/cpukit/score/src/schedulerdefaultpinunpin.c +++ b/cpukit/score/src/schedulerdefaultpinunpin.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreScheduler + * + * @brief This source file contains the implementation of + * _Scheduler_default_Pin_or_unpin(). + */ + /* * Copyright (c) 2018 embedded brains GmbH * diff --git a/cpukit/score/src/schedulerdefaultreleasejob.c b/cpukit/score/src/schedulerdefaultreleasejob.c index a1ab789ecc..f28733243a 100644 --- a/cpukit/score/src/schedulerdefaultreleasejob.c +++ b/cpukit/score/src/schedulerdefaultreleasejob.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Default Scheduler Release Job Operation - * * @ingroup RTEMSScoreScheduler + * + * @brief This source file contains the implementation of + * _Scheduler_default_Release_job() and _Scheduler_default_Cancel_job(). */ /* diff --git a/cpukit/score/src/schedulerdefaultschedule.c b/cpukit/score/src/schedulerdefaultschedule.c index a60ef53806..80e8f88ef4 100644 --- a/cpukit/score/src/schedulerdefaultschedule.c +++ b/cpukit/score/src/schedulerdefaultschedule.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreScheduler + * + * @brief This source file contains the implementation of + * _Scheduler_default_Schedule(). + */ + /* * Copyright (c) 2014 embedded brains GmbH * diff --git a/cpukit/score/src/schedulerdefaultsetaffinity.c b/cpukit/score/src/schedulerdefaultsetaffinity.c index ae3e6e613e..6399b1e352 100644 --- a/cpukit/score/src/schedulerdefaultsetaffinity.c +++ b/cpukit/score/src/schedulerdefaultsetaffinity.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Scheduler Default Set Affinity Operation - * * @ingroup RTEMSScoreScheduler + * + * @brief This source file contains the implementation of + * _Scheduler_default_Set_affinity(). */ /* diff --git a/cpukit/score/src/schedulerdefaultstartidle.c b/cpukit/score/src/schedulerdefaultstartidle.c index 9789b6966a..b35bfccf83 100644 --- a/cpukit/score/src/schedulerdefaultstartidle.c +++ b/cpukit/score/src/schedulerdefaultstartidle.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreScheduler + * + * @brief This source file contains the implementation of + * _Scheduler_default_Start_idle(). + */ + /* * Copyright (c) 2013-2014 embedded brains GmbH * diff --git a/cpukit/score/src/schedulerdefaulttick.c b/cpukit/score/src/schedulerdefaulttick.c index bf93598a7c..f4b6ba8578 100644 --- a/cpukit/score/src/schedulerdefaulttick.c +++ b/cpukit/score/src/schedulerdefaulttick.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Default Scheduler At Tick Handler - * * @ingroup RTEMSScoreScheduler + * + * @brief This source file contains the implementation of + * _Scheduler_default_Tick(). */ /* diff --git a/cpukit/score/src/scheduleredf.c b/cpukit/score/src/scheduleredf.c index 3b0c62c0c3..beb37002ff 100644 --- a/cpukit/score/src/scheduleredf.c +++ b/cpukit/score/src/scheduleredf.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerEDF * - * @brief Scheduler EDF Initialize and Support + * @brief This source file contains the implementation of + * _Scheduler_EDF_Initialize(). */ /* diff --git a/cpukit/score/src/scheduleredfblock.c b/cpukit/score/src/scheduleredfblock.c index b3b2fa4f0d..689dc21361 100644 --- a/cpukit/score/src/scheduleredfblock.c +++ b/cpukit/score/src/scheduleredfblock.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Removes the Thread from Ready Queue + * @ingroup RTEMSScoreSchedulerEDF * - * @ingroup RTEMSScoreScheduler + * @brief This source file contains the implementation of + * _Scheduler_EDF_Block(). */ /* diff --git a/cpukit/score/src/scheduleredfchangepriority.c b/cpukit/score/src/scheduleredfchangepriority.c index 42d899b876..b6d7e334ee 100644 --- a/cpukit/score/src/scheduleredfchangepriority.c +++ b/cpukit/score/src/scheduleredfchangepriority.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Scheduler EDF Extract - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerEDF + * + * @brief This source file contains the implementation of + * _Scheduler_EDF_Update_priority(). */ /* diff --git a/cpukit/score/src/scheduleredfnodeinit.c b/cpukit/score/src/scheduleredfnodeinit.c index bb938cdcd1..82b68630aa 100644 --- a/cpukit/score/src/scheduleredfnodeinit.c +++ b/cpukit/score/src/scheduleredfnodeinit.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Scheduler EDF Allocate - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerEDF + * + * @brief This source file contains the implementation of + * _Scheduler_EDF_Node_initialize(). */ /* diff --git a/cpukit/score/src/scheduleredfreleasejob.c b/cpukit/score/src/scheduleredfreleasejob.c index 0e3e527109..443fdaeed5 100644 --- a/cpukit/score/src/scheduleredfreleasejob.c +++ b/cpukit/score/src/scheduleredfreleasejob.c @@ -1,9 +1,11 @@ /** * @file * - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerEDF * - * @brief Scheduler EDF Release Job + * @brief This source file contains the implementation of + * _Scheduler_EDF_Map_priority(), _Scheduler_EDF_Unmap_priority(), + * _Scheduler_EDF_Release_job(), and _Scheduler_EDF_Cancel_job(). */ /* diff --git a/cpukit/score/src/scheduleredfschedule.c b/cpukit/score/src/scheduleredfschedule.c index 1f4823b971..126aed0150 100644 --- a/cpukit/score/src/scheduleredfschedule.c +++ b/cpukit/score/src/scheduleredfschedule.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Scheduler EDF Allocate - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerEDF + * + * @brief This source file contains the implementation of + * _Scheduler_EDF_Schedule(). */ /* diff --git a/cpukit/score/src/scheduleredfsmp.c b/cpukit/score/src/scheduleredfsmp.c index dc1fa20c86..985f06f4bf 100644 --- a/cpukit/score/src/scheduleredfsmp.c +++ b/cpukit/score/src/scheduleredfsmp.c @@ -1,9 +1,17 @@ /** * @file * - * @brief EDF SMP Scheduler Implementation - * * @ingroup RTEMSScoreSchedulerSMPEDF + * + * @brief This source file contains the implementation of + * _Scheduler_EDF_SMP_Add_processor(), _Scheduler_EDF_SMP_Ask_for_help(), + * _Scheduler_EDF_SMP_Block(), _Scheduler_EDF_SMP_Initialize(), + * _Scheduler_EDF_SMP_Node_initialize(), _Scheduler_EDF_SMP_Pin(), + * _Scheduler_EDF_SMP_Reconsider_help_request(), + * _Scheduler_EDF_SMP_Remove_processor(), _Scheduler_EDF_SMP_Set_affinity(), + * _Scheduler_EDF_SMP_Start_idle(), _Scheduler_EDF_SMP_Unblock(), + * _Scheduler_EDF_SMP_Unpin(), _Scheduler_EDF_SMP_Update_priority(), + * _Scheduler_EDF_SMP_Withdraw_node(), and _Scheduler_EDF_SMP_Yield(). */ /* diff --git a/cpukit/score/src/scheduleredfunblock.c b/cpukit/score/src/scheduleredfunblock.c index a1c45af91c..49cf88bc8d 100644 --- a/cpukit/score/src/scheduleredfunblock.c +++ b/cpukit/score/src/scheduleredfunblock.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerEDF * - * @brief Scheduler EDF Unblock + * @brief This source file contains the implementation of + * _Scheduler_EDF_Unblock(). */ /* diff --git a/cpukit/score/src/scheduleredfyield.c b/cpukit/score/src/scheduleredfyield.c index 8dc11fab8c..530a01e5a2 100644 --- a/cpukit/score/src/scheduleredfyield.c +++ b/cpukit/score/src/scheduleredfyield.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Scheduler EDF Yield + * @ingroup RTEMSScoreSchedulerEDF * - * @ingroup RTEMSScoreScheduler + * @brief This source file contains the implementation of + * _Scheduler_EDF_Yield(). */ /* diff --git a/cpukit/score/src/schedulergetaffinity.c b/cpukit/score/src/schedulergetaffinity.c index d4666499c4..87be699f5b 100644 --- a/cpukit/score/src/schedulergetaffinity.c +++ b/cpukit/score/src/schedulergetaffinity.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreScheduler + * + * @brief This source file contains the implementation of + * _Scheduler_Get_affinity(). + */ + /* * Copyright (c) 2014, 2017 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/schedulerpriority.c b/cpukit/score/src/schedulerpriority.c index bf72d8057e..e151afd5d0 100644 --- a/cpukit/score/src/schedulerpriority.c +++ b/cpukit/score/src/schedulerpriority.c @@ -1,8 +1,11 @@ -/* - * @file +/** + * @file + * + * @ingroup RTEMSScoreSchedulerPriority * - * @brief Initialize Scheduler Priority - * @ingroup RTEMSScoreScheduler + * @brief This source file contains the implementation of + * _Scheduler_priority_Initialize() and + * _Scheduler_priority_Node_initialize(). */ /* diff --git a/cpukit/score/src/schedulerpriorityaffinitysmp.c b/cpukit/score/src/schedulerpriorityaffinitysmp.c index 86ef7bf83e..2511b6bbed 100644 --- a/cpukit/score/src/schedulerpriorityaffinitysmp.c +++ b/cpukit/score/src/schedulerpriorityaffinitysmp.c @@ -1,9 +1,19 @@ /** * @file * - * @brief Deterministic Priority Affinity SMP Scheduler Implementation - * * @ingroup RTEMSScoreSchedulerPriorityAffinitySMP + * + * @brief This source file contains the implementation of + * _Scheduler_priority_affinity_SMP_Add_processor(), + * _Scheduler_priority_affinity_SMP_Ask_for_help(), + * _Scheduler_priority_affinity_SMP_Block(), + * _Scheduler_priority_affinity_SMP_Node_initialize(), + * _Scheduler_priority_affinity_SMP_Reconsider_help_request(), + * _Scheduler_priority_affinity_SMP_Remove_processor(), + * _Scheduler_priority_affinity_SMP_Set_affinity(), + * _Scheduler_priority_affinity_SMP_Unblock(), + * _Scheduler_priority_affinity_SMP_Update_priority(), and + * _Scheduler_priority_affinity_SMP_Withdraw_node(). */ /* diff --git a/cpukit/score/src/schedulerpriorityblock.c b/cpukit/score/src/schedulerpriorityblock.c index ae44710ea6..86d464aab4 100644 --- a/cpukit/score/src/schedulerpriorityblock.c +++ b/cpukit/score/src/schedulerpriorityblock.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerPriority * - * @brief Scheduler Priority Block + * @brief This source file contains the implementation of + * _Scheduler_priority_Block(). */ /* diff --git a/cpukit/score/src/schedulerprioritychangepriority.c b/cpukit/score/src/schedulerprioritychangepriority.c index 0ea1b67183..6390e0fb4f 100644 --- a/cpukit/score/src/schedulerprioritychangepriority.c +++ b/cpukit/score/src/schedulerprioritychangepriority.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Removes Thread from Thread Queue + * @ingroup RTEMSScoreSchedulerPriority * - * @ingroup RTEMSScoreScheduler + * @brief This source file contains the implementation of + * _Scheduler_priority_Update_priority(). */ /* diff --git a/cpukit/score/src/schedulerpriorityschedule.c b/cpukit/score/src/schedulerpriorityschedule.c index 7861a5861e..cfb5916017 100644 --- a/cpukit/score/src/schedulerpriorityschedule.c +++ b/cpukit/score/src/schedulerpriorityschedule.c @@ -1,11 +1,12 @@ /** * @file * - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerPriority * - * @brief Priority Scheduler Schedule Method + * @brief This source file contains the implementation of + * _Scheduler_priority_Schedule(). */ - + /* * Copyright (C) 2010 Gedare Bloom. * Copyright (C) 2011 On-Line Applications Research Corporation (OAR). diff --git a/cpukit/score/src/schedulerprioritysmp.c b/cpukit/score/src/schedulerprioritysmp.c index b1a84166fe..d6f8715e01 100644 --- a/cpukit/score/src/schedulerprioritysmp.c +++ b/cpukit/score/src/schedulerprioritysmp.c @@ -3,7 +3,17 @@ * * @ingroup RTEMSScoreSchedulerPrioritySMP * - * @brief Deterministic Priority SMP Scheduler Implementation + * @brief This source file contains the implementation of + * _Scheduler_priority_SMP_Add_processor(), + * _Scheduler_priority_SMP_Ask_for_help(), _Scheduler_priority_SMP_Block(), + * _Scheduler_priority_SMP_Initialize(), + * _Scheduler_priority_SMP_Node_initialize(), + * _Scheduler_priority_SMP_Reconsider_help_request(), + * _Scheduler_priority_SMP_Remove_processor(), + * _Scheduler_priority_SMP_Unblock(), + * _Scheduler_priority_SMP_Update_priority(), + * _Scheduler_priority_SMP_Withdraw_node(), and + * _Scheduler_priority_SMP_Yield(). */ /* diff --git a/cpukit/score/src/schedulerpriorityunblock.c b/cpukit/score/src/schedulerpriorityunblock.c index 89bf197ffc..c28852b133 100644 --- a/cpukit/score/src/schedulerpriorityunblock.c +++ b/cpukit/score/src/schedulerpriorityunblock.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Scheduler Priority Unblock - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerPriority + * + * @brief This source file contains the implementation of + * _Scheduler_priority_Unblock(). */ /* diff --git a/cpukit/score/src/schedulerpriorityyield.c b/cpukit/score/src/schedulerpriorityyield.c index cd4f3563c5..acf3d149a7 100644 --- a/cpukit/score/src/schedulerpriorityyield.c +++ b/cpukit/score/src/schedulerpriorityyield.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Scheduler Priority Yield - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerPriority + * + * @brief This source file contains the implementation of + * _Scheduler_priority_Yield(). */ /* diff --git a/cpukit/score/src/schedulersetaffinity.c b/cpukit/score/src/schedulersetaffinity.c index 37c3e57c79..8d16af3ed3 100644 --- a/cpukit/score/src/schedulersetaffinity.c +++ b/cpukit/score/src/schedulersetaffinity.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreScheduler + * + * @brief This source file contains the implementation of + * _Scheduler_Set_affinity(). + */ + /* * Copyright (c) 2014, 2017 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/schedulersimple.c b/cpukit/score/src/schedulersimple.c index 6fab5a140f..1c8bd9f165 100644 --- a/cpukit/score/src/schedulersimple.c +++ b/cpukit/score/src/schedulersimple.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Scheduler Simple Functions + * @ingroup RTEMSScoreSchedulerSimple * - * @ingroup RTEMSScoreScheduler + * @brief This source file contains the implementation of + * _Scheduler_simple_Initialize(). */ /* diff --git a/cpukit/score/src/schedulersimpleblock.c b/cpukit/score/src/schedulersimpleblock.c index 1187a9d1e8..a08cd54f01 100644 --- a/cpukit/score/src/schedulersimpleblock.c +++ b/cpukit/score/src/schedulersimpleblock.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Simple Scheduler Block a Thread + * @ingroup RTEMSScoreSchedulerSimple * - * @ingroup RTEMSScoreScheduler + * @brief This source file contains the implementation of + * _Scheduler_simple_Block(). */ /* diff --git a/cpukit/score/src/schedulersimplechangepriority.c b/cpukit/score/src/schedulersimplechangepriority.c index 448204274a..48c2473f82 100644 --- a/cpukit/score/src/schedulersimplechangepriority.c +++ b/cpukit/score/src/schedulersimplechangepriority.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Removes a Thread from the Simple Queue + * @ingroup RTEMSScoreSchedulerSimple * - * @ingroup RTEMSScoreScheduler + * @brief This source file contains the implementation of + * _Scheduler_simple_Update_priority(). */ /* diff --git a/cpukit/score/src/schedulersimpleschedule.c b/cpukit/score/src/schedulersimpleschedule.c index a48475828c..0358cfd159 100644 --- a/cpukit/score/src/schedulersimpleschedule.c +++ b/cpukit/score/src/schedulersimpleschedule.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerSimple * - * @brief Simple Schedule Determine Heir + * @brief This source file contains the implementation of + * _Scheduler_simple_Schedule(). */ /* diff --git a/cpukit/score/src/schedulersimplesmp.c b/cpukit/score/src/schedulersimplesmp.c index d818dcea80..bcb686bdd2 100644 --- a/cpukit/score/src/schedulersimplesmp.c +++ b/cpukit/score/src/schedulersimplesmp.c @@ -1,9 +1,17 @@ /** * @file * - * @brief Simple SMP Scheduler Implementation - * * @ingroup RTEMSScoreSchedulerSMPSimple + * + * @brief This source file contains the implementation of + * _Scheduler_simple_SMP_Add_processor(), + * _Scheduler_simple_SMP_Ask_for_help(), _Scheduler_simple_SMP_Block(), + * _Scheduler_simple_SMP_Initialize(), + * _Scheduler_simple_SMP_Node_initialize(), + * _Scheduler_simple_SMP_Reconsider_help_request(), + * _Scheduler_simple_SMP_Remove_processor(), _Scheduler_simple_SMP_Unblock(), + * _Scheduler_simple_SMP_Update_priority(), + * _Scheduler_simple_SMP_Withdraw_node(), and _Scheduler_simple_SMP_Yield(). */ /* diff --git a/cpukit/score/src/schedulersimpleunblock.c b/cpukit/score/src/schedulersimpleunblock.c index 516b5f2675..cd4dded017 100644 --- a/cpukit/score/src/schedulersimpleunblock.c +++ b/cpukit/score/src/schedulersimpleunblock.c @@ -1,9 +1,10 @@ /** * @file - * - * @ingroup RTEMSScoreScheduler * - * @brief Scheduler Simple Handler / Unblock + * @ingroup RTEMSScoreSchedulerSimple + * + * @brief This source file contains the implementation of + * _Scheduler_simple_Unblock(). */ /* diff --git a/cpukit/score/src/schedulersimpleyield.c b/cpukit/score/src/schedulersimpleyield.c index db78660719..24f5dc59c1 100644 --- a/cpukit/score/src/schedulersimpleyield.c +++ b/cpukit/score/src/schedulersimpleyield.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup RTEMSScoreScheduler + * @ingroup RTEMSScoreSchedulerSimple * - * @brief Simple Schedule Yield CPU + * @brief This source file contains the implementation of + * _Scheduler_simple_Yield(). */ /* diff --git a/cpukit/score/src/schedulersmp.c b/cpukit/score/src/schedulersmp.c index cb1ab6e0f1..cc566180b7 100644 --- a/cpukit/score/src/schedulersmp.c +++ b/cpukit/score/src/schedulersmp.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreScheduler + * + * @brief This source file contains the implementation of + * _Scheduler_Request_ask_for_help(). + */ + /* * Copyright (c) 2014, 2017 embedded brains GmbH. * diff --git a/cpukit/score/src/schedulersmpstartidle.c b/cpukit/score/src/schedulersmpstartidle.c index e4e34ed3f8..0c7da3d7d2 100644 --- a/cpukit/score/src/schedulersmpstartidle.c +++ b/cpukit/score/src/schedulersmpstartidle.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreScheduler + * + * @brief This source file contains the implementation of + * _Scheduler_SMP_Start_idle(). + */ + /* * Copyright (c) 2013, 2017 embedded brains GmbH. * diff --git a/cpukit/score/src/schedulerstrongapa.c b/cpukit/score/src/schedulerstrongapa.c index 924cd86412..dcfb55601a 100644 --- a/cpukit/score/src/schedulerstrongapa.c +++ b/cpukit/score/src/schedulerstrongapa.c @@ -3,7 +3,15 @@ * * @ingroup RTEMSScoreSchedulerStrongAPA * - * @brief Strong APA Scheduler Implementation + * @brief This source file contains the implementation of + * _Scheduler_strong_APA_Add_processor(), + * _Scheduler_strong_APA_Ask_for_help(), _Scheduler_strong_APA_Block(), + * _Scheduler_strong_APA_Initialize(), + * _Scheduler_strong_APA_Node_initialize(), + * _Scheduler_strong_APA_Reconsider_help_request(), + * _Scheduler_strong_APA_Remove_processor(), _Scheduler_strong_APA_Unblock(), + * _Scheduler_strong_APA_Update_priority(), + * _Scheduler_strong_APA_Withdraw_node(), and _Scheduler_strong_APA_Yield(). */ /* diff --git a/cpukit/score/src/semaphore.c b/cpukit/score/src/semaphore.c index e133d6082d..db3c3a91eb 100644 --- a/cpukit/score/src/semaphore.c +++ b/cpukit/score/src/semaphore.c @@ -1,3 +1,13 @@ +/** + * @file + * + * @ingroup RTEMSScore + * + * @brief This source file contains the implementation of + * _Semaphore_Wait(), _Semaphore_Wait_timed_ticks(), _Semaphore_Try_wait(), + * _Semaphore_Post(), and _Semaphore_Post_binary(). + */ + /* * Copyright (c) 2015, 2017 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/smp.c b/cpukit/score/src/smp.c index 0aab731dc8..2a3405c6ef 100644 --- a/cpukit/score/src/smp.c +++ b/cpukit/score/src/smp.c @@ -1,8 +1,15 @@ /** - * @file + * @file * - * @brief SMP Support - * @ingroup RTEMSScore + * @ingroup RTEMSScoreSMP + * + * @brief This source file contains the definition of ::_SMP_Online_processors + * and ::_SMP_Processor_maximum and the implementation of + * _SMP_Handler_initialize(), _SMP_Request_shutdown(), + * _SMP_Request_start_multitasking(), _SMP_Send_message(), + * _SMP_Send_message_broadcast(), _SMP_Send_message_multicast(), + * _SMP_Should_start_processor(), and + * _SMP_Start_multitasking_on_secondary_processor(). */ /* diff --git a/cpukit/score/src/smpbarrierwait.c b/cpukit/score/src/smpbarrierwait.c index 152338af00..c67d13af6f 100644 --- a/cpukit/score/src/smpbarrierwait.c +++ b/cpukit/score/src/smpbarrierwait.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreSMPBarrier + * + * @brief This source file contains the implementation of + * _SMP_barrier_Wait(). + */ + /* * Copyright (c) 2013-2014 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/smplock.c b/cpukit/score/src/smplock.c index 3523098677..b2d08cd6a1 100644 --- a/cpukit/score/src/smplock.c +++ b/cpukit/score/src/smplock.c @@ -1,3 +1,14 @@ +/** + * @file + * + * @ingroup RTEMSScoreSMPLock + * + * @brief This source file contains the implementation of + * _SMP_lock_Initialize(), _SMP_lock_Destroy(), _SMP_lock_Acquire(), + * _SMP_lock_Release(), _SMP_lock_ISR_disable_and_acquire(), + * _SMP_lock_Release_and_ISR_enable(), and _SMP_lock_Is_owner(). + */ + /* * Copyright (c) 2015, 2016 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/smpmulticastaction.c b/cpukit/score/src/smpmulticastaction.c index facc77af41..55c495a2cf 100644 --- a/cpukit/score/src/smpmulticastaction.c +++ b/cpukit/score/src/smpmulticastaction.c @@ -1,6 +1,17 @@ -/* - * SPDX-License-Identifier: BSD-2-Clause +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSScorePerCPU + * @ingroup RTEMSScoreSMP * + * @brief This source file contains the implementation of _Per_CPU_Add_job(), + * _Per_CPU_Perform_jobs(), _Per_CPU_Wait_for_job(), _SMP_Broadcast_action(), + * _SMP_Multicast_action(), _SMP_Othercast_action(), and _SMP_Synchronize(). + */ + +/* * Copyright (C) 2019 embedded brains GmbH * * Redistribution and use in source and binary forms, with or without diff --git a/cpukit/score/src/smpunicastaction.c b/cpukit/score/src/smpunicastaction.c index 1b170cabd2..bc481eb4a4 100644 --- a/cpukit/score/src/smpunicastaction.c +++ b/cpukit/score/src/smpunicastaction.c @@ -1,6 +1,15 @@ -/* - * SPDX-License-Identifier: BSD-2-Clause +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSScoreSMP * + * @brief This source file contains the implementation of + * _SMP_Unicast_action(). + */ + +/* * Copyright (C) 2019 embedded brains GmbH * * Redistribution and use in source and binary forms, with or without diff --git a/cpukit/score/src/stackallocator.c b/cpukit/score/src/stackallocator.c index 6fd8bf9489..920aee86c1 100644 --- a/cpukit/score/src/stackallocator.c +++ b/cpukit/score/src/stackallocator.c @@ -1,6 +1,16 @@ -/* - * SPDX-License-Identifier: BSD-2-Clause +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSScoreStack * + * @brief This source file contains a definition of + * ::_Stack_Allocator_avoids_workspace and ::_Stack_Allocator_allocate which + * allocates the thread stacks from the RTEMS Workspace. + */ + +/* * Copyright (C) 2019 embedded brains GmbH * * Redistribution and use in source and binary forms, with or without diff --git a/cpukit/score/src/stackallocatorfree.c b/cpukit/score/src/stackallocatorfree.c index efb63d7cca..f32912ea9c 100644 --- a/cpukit/score/src/stackallocatorfree.c +++ b/cpukit/score/src/stackallocatorfree.c @@ -1,6 +1,15 @@ -/* - * SPDX-License-Identifier: BSD-2-Clause +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSScoreStack * + * @brief This source file contains a definition of ::_Stack_Allocator_free + * which frees the thread stacks to the RTEMS Workspace. + */ + +/* * Copyright (C) 2019 embedded brains GmbH * * Redistribution and use in source and binary forms, with or without diff --git a/cpukit/score/src/stackallocatorfreenothing.c b/cpukit/score/src/stackallocatorfreenothing.c index b469f650b6..e341814b0c 100644 --- a/cpukit/score/src/stackallocatorfreenothing.c +++ b/cpukit/score/src/stackallocatorfreenothing.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSScoreStack * - * @brief _Stack_Free_nothing() Implementation + * @brief This source file contains the implementation of + * _Stack_Free_nothing(). */ /* diff --git a/cpukit/score/src/stackallocatorinit.c b/cpukit/score/src/stackallocatorinit.c index 31e239bd46..a57a253301 100644 --- a/cpukit/score/src/stackallocatorinit.c +++ b/cpukit/score/src/stackallocatorinit.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSScoreStack * - * @brief Stack Allocator Initialization + * @brief This source file contains the implementation of + * _Stack_Allocator_do_initialize(). */ /* diff --git a/cpukit/score/src/thread.c b/cpukit/score/src/thread.c index 3dde437e72..d66ec80d69 100644 --- a/cpukit/score/src/thread.c +++ b/cpukit/score/src/thread.c @@ -1,8 +1,11 @@ /** - * @file + * @file * - * @brief Initialize Thread Handler - * @ingroup RTEMSScoreThread + * @ingroup RTEMSScoreThread + * + * @brief This source file contains static assertions related to the Thread + * Handler and the implementation of _Thread_Initialize_information() and + * _Thread_Handler_initialization(). */ /* diff --git a/cpukit/score/src/threadallocateunlimited.c b/cpukit/score/src/threadallocateunlimited.c index 6f2dec7388..6bd3b3ec7a 100644 --- a/cpukit/score/src/threadallocateunlimited.c +++ b/cpukit/score/src/threadallocateunlimited.c @@ -1,12 +1,15 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + /** * @file * * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Extend_information(). */ /* - * SPDX-License-Identifier: BSD-2-Clause - * * Copyright (C) 2019, 2020 embedded brains GmbH * * Redistribution and use in source and binary forms, with or without diff --git a/cpukit/score/src/threadchangepriority.c b/cpukit/score/src/threadchangepriority.c index 458eae810a..13e9147916 100644 --- a/cpukit/score/src/threadchangepriority.c +++ b/cpukit/score/src/threadchangepriority.c @@ -1,9 +1,13 @@ /** * @file * - * @brief Changes the Priority of a Thread - * * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Priority_add(), _Thread_Priority_and_sticky_update(), + * _Thread_Priority_changed(), _Thread_Priority_perform_actions(), + * _Thread_Priority_remove(), _Thread_Priority_replace(), and + * _Thread_Priority_update(). */ /* diff --git a/cpukit/score/src/threadclearstate.c b/cpukit/score/src/threadclearstate.c index 3af759e310..0ee9c4b184 100644 --- a/cpukit/score/src/threadclearstate.c +++ b/cpukit/score/src/threadclearstate.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Clear Thread state - * @ingroup RTEMSScoreThread + * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Clear_state_locked() and _Thread_Clear_state(). */ /* diff --git a/cpukit/score/src/threadcreateidle.c b/cpukit/score/src/threadcreateidle.c index 1e18ad07cc..50114b84de 100644 --- a/cpukit/score/src/threadcreateidle.c +++ b/cpukit/score/src/threadcreateidle.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Create Idle Thread - * @ingroup RTEMSScoreThread + * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Create_idle(). */ /* diff --git a/cpukit/score/src/threaddispatch.c b/cpukit/score/src/threaddispatch.c index c57ddb01ae..c4dadc0ff1 100644 --- a/cpukit/score/src/threaddispatch.c +++ b/cpukit/score/src/threaddispatch.c @@ -1,9 +1,12 @@ /** * @file - * + * * @ingroup RTEMSScoreThread * - * @brief Dispatch Thread + * @brief This source file contains the definition of ::_Thread_Allocated_fp + * and ::_User_extensions_Switches_list and the implementation of + * _Thread_Dispatch(), _Thread_Dispatch_direct(), _Thread_Dispatch_enable(), + * and _Thread_Do_dispatch(). */ /* diff --git a/cpukit/score/src/threadentryadaptoridle.c b/cpukit/score/src/threadentryadaptoridle.c index c3034a6c8d..270953df4e 100644 --- a/cpukit/score/src/threadentryadaptoridle.c +++ b/cpukit/score/src/threadentryadaptoridle.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Entry_adaptor_idle(). + */ + /* * Copyright (c) 2015 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/threadentryadaptornumeric.c b/cpukit/score/src/threadentryadaptornumeric.c index 78cf700e2b..a1a2ad2206 100644 --- a/cpukit/score/src/threadentryadaptornumeric.c +++ b/cpukit/score/src/threadentryadaptornumeric.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Entry_adaptor_numeric(). + */ + /* * Copyright (c) 2015 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/threadentryadaptorpointer.c b/cpukit/score/src/threadentryadaptorpointer.c index 4ba6227230..d5a3111912 100644 --- a/cpukit/score/src/threadentryadaptorpointer.c +++ b/cpukit/score/src/threadentryadaptorpointer.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Entry_adaptor_pointer(). + */ + /* * Copyright (c) 2015 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/threadget.c b/cpukit/score/src/threadget.c index 1333253289..d596cd5ac4 100644 --- a/cpukit/score/src/threadget.c +++ b/cpukit/score/src/threadget.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Maps Thread IDs to TCB Pointer - * * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Get(). */ /* diff --git a/cpukit/score/src/threadgetcputimeused.c b/cpukit/score/src/threadgetcputimeused.c index b89050af96..7406da0bf3 100644 --- a/cpukit/score/src/threadgetcputimeused.c +++ b/cpukit/score/src/threadgetcputimeused.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Get_CPU_time_used(). + */ + /* * Copyright (c) 2016 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/threadhandler.c b/cpukit/score/src/threadhandler.c index 6742b0b391..5ad927f391 100644 --- a/cpukit/score/src/threadhandler.c +++ b/cpukit/score/src/threadhandler.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Thread Handler - * @ingroup RTEMSScoreThread + * @ingroup RTEMSScoreThread + * + * @brief This source file contains the definition of + * ::_Thread_Global_constructor and the implementation of _Thread_Handler(). */ /* diff --git a/cpukit/score/src/threadidledefault.c b/cpukit/score/src/threadidledefault.c index 88dbbb5331..2386c0317d 100644 --- a/cpukit/score/src/threadidledefault.c +++ b/cpukit/score/src/threadidledefault.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreThread + * + * @brief This source file contains the default definition of + * ::_Thread_Idle_body. + */ + /* * SPDX-License-Identifier: BSD-2-Clause * diff --git a/cpukit/score/src/threadinitialize.c b/cpukit/score/src/threadinitialize.c index 4c6d849111..05c30c3d43 100644 --- a/cpukit/score/src/threadinitialize.c +++ b/cpukit/score/src/threadinitialize.c @@ -1,10 +1,12 @@ /** - * @file + * @file * - * @brief Initialize Thread + * @ingroup RTEMSScoreThread * - * @ingroup RTEMSScoreThread + * @brief This source file contains the implementation of + * _Thread_Initialize(). */ + /* * COPYRIGHT (c) 1989-2014. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/score/src/threaditerate.c b/cpukit/score/src/threaditerate.c index 455aa1b91a..5e4ceff83e 100644 --- a/cpukit/score/src/threaditerate.c +++ b/cpukit/score/src/threaditerate.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Iterate(). + */ + /* * Copyright (c) 2016 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/threadloadenv.c b/cpukit/score/src/threadloadenv.c index 9b0808cbf8..fec2a616d8 100644 --- a/cpukit/score/src/threadloadenv.c +++ b/cpukit/score/src/threadloadenv.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Initializes Enviroment for A Thread - * * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Load_environment(). */ /* diff --git a/cpukit/score/src/threadmp.c b/cpukit/score/src/threadmp.c index d03800abd2..fd595251bc 100644 --- a/cpukit/score/src/threadmp.c +++ b/cpukit/score/src/threadmp.c @@ -1,8 +1,11 @@ /** - * @file + * @file * - * @brief Distributed MP Support - * @ingroup RTEMSScoreThreadMP + * @ingroup RTEMSScoreThreadMP + * + * @brief This source file contains the implementation of + * _Thread_MP_Handler_initialization(), _Thread_MP_Allocate_proxy(), + * _Thread_MP_Find_proxy(), _Thread_MP_Free_proxy(). */ /* diff --git a/cpukit/score/src/threadname.c b/cpukit/score/src/threadname.c index 95abc7d209..6e41911186 100644 --- a/cpukit/score/src/threadname.c +++ b/cpukit/score/src/threadname.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Set_name() and _Thread_Get_name(). + */ + /* * Copyright (c) 2017 embedded brains GmbH. * diff --git a/cpukit/score/src/threadq.c b/cpukit/score/src/threadq.c index ffce17a857..55d8760f7c 100644 --- a/cpukit/score/src/threadq.c +++ b/cpukit/score/src/threadq.c @@ -1,8 +1,15 @@ /** - * @file + * @file * - * @brief Thread Queue Initialize - * @ingroup RTEMSScoreThreadQ + * @ingroup RTEMSScoreThreadQueue + * + * @brief This source file contains static assertions related to the Thread + * Queue Handler, the definition of ::_Thread_queue_Object_name, and the + * implementation of _Thread_queue_Acquire(), + * _Thread_queue_Do_acquire_critical(), _Thread_queue_Initialize(), + * _Thread_queue_MP_callout_do_nothing(), _Thread_queue_Object_initialize(), + * _Thread_queue_Queue_get_name_and_id(), _Thread_queue_Release(), and + * _Thread_queue_Release_critical(). */ /* diff --git a/cpukit/score/src/threadqenqueue.c b/cpukit/score/src/threadqenqueue.c index f0a28457a1..ba31b13dd1 100644 --- a/cpukit/score/src/threadqenqueue.c +++ b/cpukit/score/src/threadqenqueue.c @@ -1,9 +1,16 @@ /** * @file * - * @ingroup RTEMSScoreThreadQ + * @ingroup RTEMSScoreThreadQueue * - * @brief Thread Queue Operations + * @brief This source file contains the implementation of + * _Thread_queue_Deadlock_fatal(), _Thread_queue_Deadlock_status(), + * _Thread_queue_Do_dequeue(), _Thread_queue_Enqueue(), + * _Thread_queue_Enqueue_do_nothing_extra(), _Thread_queue_Enqueue_sticky(), + * _Thread_queue_Extract(), _Thread_queue_Extract_critical(), + * _Thread_queue_Extract_locked(), _Thread_queue_Path_acquire_critical(), + * _Thread_queue_Path_release_critical(), _Thread_queue_Surrender(), + * _Thread_queue_Surrender_sticky(), and _Thread_queue_Unblock_critical(). */ /* diff --git a/cpukit/score/src/threadqextractwithproxy.c b/cpukit/score/src/threadqextractwithproxy.c index d9b6f58c78..1370aecb86 100644 --- a/cpukit/score/src/threadqextractwithproxy.c +++ b/cpukit/score/src/threadqextractwithproxy.c @@ -1,13 +1,10 @@ /** - * @brief _Thread_queue_Extract_with_proxy + * @file * - * This routine extracts the_thread from the_thread_queue - * and ensures that if there is a proxy for this task on - * another node, it is also dealt with. A proxy is a data - * data that is on the thread queue on the remote node and - * acts as a proxy for the local thread. If the local thread - * was waiting on a remote operation, then the remote side - * of the operation must be cleaned up. + * @ingroup RTEMSScoreThreadQueue + * + * @brief This source file contains the implementation of + * _Thread_queue_Extract_with_proxy(). */ /* diff --git a/cpukit/score/src/threadqfirst.c b/cpukit/score/src/threadqfirst.c index 4c3939ff7a..9908523298 100644 --- a/cpukit/score/src/threadqfirst.c +++ b/cpukit/score/src/threadqfirst.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Thread Queue First - * @ingroup RTEMSScoreThreadQ + * @ingroup RTEMSScoreThreadQueue + * + * @brief This source file contains the implementation of + * _Thread_queue_First(). */ /* diff --git a/cpukit/score/src/threadqflush.c b/cpukit/score/src/threadqflush.c index 5666aaf22c..357e3d696e 100644 --- a/cpukit/score/src/threadqflush.c +++ b/cpukit/score/src/threadqflush.c @@ -1,9 +1,13 @@ /** * @file * - * @ingroup RTEMSScoreThreadQ + * @ingroup RTEMSScoreThreadQueue * - * @brief Thread Queue Flush + * @brief This source file contains the implementation of + * _Thread_queue_Flush_default_filter(), + * _Thread_queue_Flush_status_object_was_deleted(), + * _Thread_queue_Flush_status_unavailable(), and + * _Thread_queue_Flush_critical(). */ /* diff --git a/cpukit/score/src/threadqops.c b/cpukit/score/src/threadqops.c index 9894c3628b..9cf63d41f6 100644 --- a/cpukit/score/src/threadqops.c +++ b/cpukit/score/src/threadqops.c @@ -1,3 +1,14 @@ +/** + * @file + * + * @ingroup RTEMSScoreThreadQueue + * + * @brief This source file contains the definition of + * ::_Thread_queue_Operations_default, ::_Thread_queue_Operations_FIFO, + * ::_Thread_queue_Operations_priority, and + * ::_Thread_queue_Operations_priority_inherit. + */ + /* * Copyright (c) 2015, 2016 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/threadqtimeout.c b/cpukit/score/src/threadqtimeout.c index 3a08342740..ec8f67c93b 100644 --- a/cpukit/score/src/threadqtimeout.c +++ b/cpukit/score/src/threadqtimeout.c @@ -1,3 +1,14 @@ +/** + * @file + * + * @ingroup RTEMSScoreThreadQueue + * + * @brief This source file contains the implementation of + * _Thread_queue_Add_timeout_ticks(), _Thread_queue_Add_timeout_timespec(), + * _Thread_queue_Add_timeout_monotonic_timespec(), and + * _Thread_queue_Add_timeout_realtime_timespec(). + */ + /* * Copyright (c) 2016, 2017 embedded brains GmbH * diff --git a/cpukit/score/src/threadrestart.c b/cpukit/score/src/threadrestart.c index 3350bfe464..b4204f7fbb 100644 --- a/cpukit/score/src/threadrestart.c +++ b/cpukit/score/src/threadrestart.c @@ -3,7 +3,10 @@ * * @ingroup RTEMSScoreThread * - * @brief Restart Thread + * @brief This source file contains the implementation of _Thread_Cancel(), + * _Thread_Change_life(), _Thread_Close(), _Thread_Exit(), _Thread_Join(), + * _Thread_Kill_zombies(), _Thread_Restart_other(), _Thread_Restart_self(), + * and _Thread_Set_life_protection(). */ /* diff --git a/cpukit/score/src/threadscheduler.c b/cpukit/score/src/threadscheduler.c index bacb4e746d..19459e8dec 100644 --- a/cpukit/score/src/threadscheduler.c +++ b/cpukit/score/src/threadscheduler.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Scheduler_process_requests(). + */ + /* * Copyright (c) 2016 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/threadsetstate.c b/cpukit/score/src/threadsetstate.c index d07ae05fdd..ecfab2fdd6 100644 --- a/cpukit/score/src/threadsetstate.c +++ b/cpukit/score/src/threadsetstate.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Sets States for a Thread - * * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Set_state_locked() and _Thread_Set_state. */ /* diff --git a/cpukit/score/src/threadstackallocate.c b/cpukit/score/src/threadstackallocate.c index 2ca7ec2bff..55f4370fd2 100644 --- a/cpukit/score/src/threadstackallocate.c +++ b/cpukit/score/src/threadstackallocate.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreStack * - * @brief Stack Allocate Helper + * @brief This source file contains the implementation of + * _Stack_Allocate(). */ /* diff --git a/cpukit/score/src/threadstackfree.c b/cpukit/score/src/threadstackfree.c index 3e70f8b3e4..ffe13dc9ce 100644 --- a/cpukit/score/src/threadstackfree.c +++ b/cpukit/score/src/threadstackfree.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreStack * - * @brief Deallocate Thread Stack + * @brief This source file contains the implementation of + * _Stack_Free(). */ /* diff --git a/cpukit/score/src/threadstart.c b/cpukit/score/src/threadstart.c index 5d49e9ea5a..e75c536a2c 100644 --- a/cpukit/score/src/threadstart.c +++ b/cpukit/score/src/threadstart.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Initializes Thread and Executes it - * * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Start(). */ /* diff --git a/cpukit/score/src/threadstartmultitasking.c b/cpukit/score/src/threadstartmultitasking.c index 5b2b99310a..a0b465a226 100644 --- a/cpukit/score/src/threadstartmultitasking.c +++ b/cpukit/score/src/threadstartmultitasking.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Start Thread Multitasking - * @ingroup RTEMSScoreThread + * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Start_multitasking(). */ /* diff --git a/cpukit/score/src/threadtimeout.c b/cpukit/score/src/threadtimeout.c index 6d14001d27..2f2017bebe 100644 --- a/cpukit/score/src/threadtimeout.c +++ b/cpukit/score/src/threadtimeout.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Thread Wait Timeout - * * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Continue() and _Thread_Timeout(). */ /* diff --git a/cpukit/score/src/threadunpin.c b/cpukit/score/src/threadunpin.c index f3ed0cf07e..eacc40f984 100644 --- a/cpukit/score/src/threadunpin.c +++ b/cpukit/score/src/threadunpin.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Do_unpin(). + */ + /* * Copyright (c) 2018 embedded brains GmbH * diff --git a/cpukit/score/src/threadwaitgetid.c b/cpukit/score/src/threadwaitgetid.c index 62982417f8..b5d652870b 100644 --- a/cpukit/score/src/threadwaitgetid.c +++ b/cpukit/score/src/threadwaitgetid.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Wait_get_id(). + */ + /* * Copyright (c) 2016, 2017 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/threadyield.c b/cpukit/score/src/threadyield.c index 8585e2ca43..e69b689ee7 100644 --- a/cpukit/score/src/threadyield.c +++ b/cpukit/score/src/threadyield.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Thread Yield - * * @ingroup RTEMSScoreThread + * + * @brief This source file contains the implementation of + * _Thread_Yield(). */ /* diff --git a/cpukit/score/src/timespecaddto.c b/cpukit/score/src/timespecaddto.c index cd2dca8db7..363fac19eb 100644 --- a/cpukit/score/src/timespecaddto.c +++ b/cpukit/score/src/timespecaddto.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Add to a Timespec - * @ingroup Timespec + * @ingroup RTEMSScoreTimespec + * + * @brief This source file contains the implementation of + * _Timespec_Add_to(). */ /* diff --git a/cpukit/score/src/timespecdivide.c b/cpukit/score/src/timespecdivide.c index 3c075fa75f..6934f649b1 100644 --- a/cpukit/score/src/timespecdivide.c +++ b/cpukit/score/src/timespecdivide.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup Timespec + * @ingroup RTEMSScoreTimespec * - * @brief Divide Timespec By Integer + * @brief This source file contains the implementation of + * _Timespec_Divide(). */ /* diff --git a/cpukit/score/src/timespecdividebyinteger.c b/cpukit/score/src/timespecdividebyinteger.c index 5534196ece..8cf227ec31 100644 --- a/cpukit/score/src/timespecdividebyinteger.c +++ b/cpukit/score/src/timespecdividebyinteger.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Divide Timespec By Integer + * @ingroup RTEMSScoreTimespec * - * @ingroup Timespec + * @brief This source file contains the implementation of + * _Timespec_Divide_by_integer(). */ /* diff --git a/cpukit/score/src/timespecfromticks.c b/cpukit/score/src/timespecfromticks.c index 2d3207a899..497762326f 100644 --- a/cpukit/score/src/timespecfromticks.c +++ b/cpukit/score/src/timespecfromticks.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Convert Ticks to Timespec - * @ingroup Timespec + * @ingroup RTEMSScoreTimespec + * + * @brief This source file contains the implementation of + * _Timespec_From_ticks(). */ /* diff --git a/cpukit/score/src/timespecgetasnanoseconds.c b/cpukit/score/src/timespecgetasnanoseconds.c index 7435464986..96b4f64467 100644 --- a/cpukit/score/src/timespecgetasnanoseconds.c +++ b/cpukit/score/src/timespecgetasnanoseconds.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Get As Nanoseconds - * @ingroup Timespec + * @ingroup RTEMSScoreTimespec + * + * @brief This source file contains the implementation of + * _Timespec_Get_as_nanoseconds(). */ /* diff --git a/cpukit/score/src/timespecisvalid.c b/cpukit/score/src/timespecisvalid.c index 88743f67ce..69d6be2448 100644 --- a/cpukit/score/src/timespecisvalid.c +++ b/cpukit/score/src/timespecisvalid.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Is Timespec Valid - * @ingroup Timespec + * @ingroup RTEMSScoreTimespec + * + * @brief This source file contains the implementation of + * _Timespec_Is_valid(). */ /* diff --git a/cpukit/score/src/timespeclessthan.c b/cpukit/score/src/timespeclessthan.c index 13a57cefe9..9239cd20a1 100644 --- a/cpukit/score/src/timespeclessthan.c +++ b/cpukit/score/src/timespeclessthan.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Timespec Less Than Operator - * @ingroup Timespec + * @ingroup RTEMSScoreTimespec + * + * @brief This source file contains the implementation of + * _Timespec_Less_than(). */ /* diff --git a/cpukit/score/src/timespecsubtract.c b/cpukit/score/src/timespecsubtract.c index cd07d8677f..8e444b97bc 100644 --- a/cpukit/score/src/timespecsubtract.c +++ b/cpukit/score/src/timespecsubtract.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Subtract Two Timespec - * @ingroup Timespec + * @ingroup RTEMSScoreTimespec + * + * @brief This source file contains the implementation of + * _Timespec_Subtract(). */ /* diff --git a/cpukit/score/src/timespectoticks.c b/cpukit/score/src/timespectoticks.c index f37504c058..d099bf25f5 100644 --- a/cpukit/score/src/timespectoticks.c +++ b/cpukit/score/src/timespectoticks.c @@ -1,5 +1,10 @@ /** - * @file + * @file + * + * @ingroup RTEMSScoreTimespec + * + * @brief This source file contains the implementation of + * _Timespec_To_ticks(). */ /* diff --git a/cpukit/score/src/tlsallocsize.c b/cpukit/score/src/tlsallocsize.c index a9f0c0cd23..e7854c677a 100644 --- a/cpukit/score/src/tlsallocsize.c +++ b/cpukit/score/src/tlsallocsize.c @@ -1,5 +1,14 @@ /* SPDX-License-Identifier: BSD-2-Clause */ +/** + * @file + * + * @ingroup RTEMSScoreTLS + * + * @brief This source file contains the implementation of + * _TLS_Get_allocation_size(). + */ + /* * Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de) * diff --git a/cpukit/score/src/userext.c b/cpukit/score/src/userext.c index 6106cd8217..0c3ac4f67d 100644 --- a/cpukit/score/src/userext.c +++ b/cpukit/score/src/userext.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreUserExt * - * @brief User Extension Handler implementation. + * @brief This source file contains the implementation of + * _User_extensions_Handler_initialization(). */ /* diff --git a/cpukit/score/src/userextaddset.c b/cpukit/score/src/userextaddset.c index f4f709b4b5..aa21e08b85 100644 --- a/cpukit/score/src/userextaddset.c +++ b/cpukit/score/src/userextaddset.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreUserExt * - * @brief User Extension Handler implementation. + * @brief This source file contains the implementation of + * _User_extensions_Add_set(). */ /* diff --git a/cpukit/score/src/userextiterate.c b/cpukit/score/src/userextiterate.c index 06665a2d7a..a25a4ad768 100644 --- a/cpukit/score/src/userextiterate.c +++ b/cpukit/score/src/userextiterate.c @@ -1,9 +1,17 @@ /** * @file * - * @brief User Extension Iteration Helpers - * * @ingroup RTEMSScoreUserExt + * + * @brief This source file contains the definition of ::_User_extensions_List + * and the implementation of _User_extensions_Fatal_visitor(), + * _User_extensions_Iterate(), _User_extensions_Thread_begin_visitor(), + * _User_extensions_Thread_create_visitor(), + * _User_extensions_Thread_delete_visitor(), + * _User_extensions_Thread_exitted_visitor(), + * _User_extensions_Thread_restart_visitor(), + * _User_extensions_Thread_start_visitor(), and + * _User_extensions_Thread_terminate_visitor(). */ /* diff --git a/cpukit/score/src/userextremoveset.c b/cpukit/score/src/userextremoveset.c index aeb54a3f8f..d0efae6a2e 100644 --- a/cpukit/score/src/userextremoveset.c +++ b/cpukit/score/src/userextremoveset.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreUserExt * - * @brief User Extension Handler implementation. + * @brief This source file contains the implementation of + * _User_extensions_Remove_set(). */ /* diff --git a/cpukit/score/src/watchdoginsert.c b/cpukit/score/src/watchdoginsert.c index 766b828368..7e74325f0e 100644 --- a/cpukit/score/src/watchdoginsert.c +++ b/cpukit/score/src/watchdoginsert.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreWatchdog * - * @brief Watchdog Insert + * @brief This source file contains the implementation of + * _Watchdog_Insert(). */ /* diff --git a/cpukit/score/src/watchdogremove.c b/cpukit/score/src/watchdogremove.c index 44a5ea26f3..1af5eccd34 100644 --- a/cpukit/score/src/watchdogremove.c +++ b/cpukit/score/src/watchdogremove.c @@ -3,7 +3,8 @@ * * @ingroup RTEMSScoreWatchdog * - * @brief Remove Watchdog + * @brief This source file contains the implementation of + * _Watchdog_Remove(). */ /* diff --git a/cpukit/score/src/watchdogtick.c b/cpukit/score/src/watchdogtick.c index 791f9e0573..e77ca4e1e1 100644 --- a/cpukit/score/src/watchdogtick.c +++ b/cpukit/score/src/watchdogtick.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreWatchdog + * + * @brief This source file contains the implementation of + * _Watchdog_Do_tickle() and _Watchdog_Tick(). + */ + /* * Copyright (c) 2015, 2016 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/score/src/watchdogtickssinceboot.c b/cpukit/score/src/watchdogtickssinceboot.c index c522608169..b746f087f4 100644 --- a/cpukit/score/src/watchdogtickssinceboot.c +++ b/cpukit/score/src/watchdogtickssinceboot.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Watchdog Ticks Since Boot - * @ingroup RTEMSScoreWatchdog + * @ingroup RTEMSScoreWatchdog + * + * @brief This source file contains the definition of + * ::_Watchdog_Ticks_since_boot. */ /* diff --git a/cpukit/score/src/watchdogtimeslicedefault.c b/cpukit/score/src/watchdogtimeslicedefault.c index 1e6ab5a91c..56f6bdb5d5 100644 --- a/cpukit/score/src/watchdogtimeslicedefault.c +++ b/cpukit/score/src/watchdogtimeslicedefault.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreWatchdog + * + * @brief This source file contains the default definition of + * ::_Watchdog_Ticks_per_timeslice. + */ + /* * SPDX-License-Identifier: BSD-2-Clause * diff --git a/cpukit/score/src/wkspace.c b/cpukit/score/src/wkspace.c index fdc046313e..3ca3c8387e 100644 --- a/cpukit/score/src/wkspace.c +++ b/cpukit/score/src/wkspace.c @@ -1,8 +1,12 @@ /** - * @file + * @file * - * @brief Workspace Handler Support - * @ingroup RTEMSScoreWorkspace + * @ingroup RTEMSScoreWorkspace + * + * @brief This source file contains the definition of ::_Workspace_Area, the + * implementation of _Workspace_Handler_initialization(), + * _Workspace_Allocate(), and _Workspace_Free(), and the Workspace Handler + * system initialization. */ /* diff --git a/cpukit/score/src/wkspaceisunifieddefault.c b/cpukit/score/src/wkspaceisunifieddefault.c index 3c357505b4..db38c968b7 100644 --- a/cpukit/score/src/wkspaceisunifieddefault.c +++ b/cpukit/score/src/wkspaceisunifieddefault.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSScoreWorkspace + * + * @brief This source file contains the default definition of + * ::_Workspace_Is_unified. + */ + /* * SPDX-License-Identifier: BSD-2-Clause * diff --git a/cpukit/score/src/wkspacemallocinitdefault.c b/cpukit/score/src/wkspacemallocinitdefault.c index 586c3eef7c..6ee951cff1 100644 --- a/cpukit/score/src/wkspacemallocinitdefault.c +++ b/cpukit/score/src/wkspacemallocinitdefault.c @@ -5,8 +5,8 @@ * * @ingroup RTEMSScoreWorkspace * - * @brief This source file provides the default definition of - * _Workspace_Malloc_initializer. + * @brief This source file contains the default definition of + * ::_Workspace_Malloc_initializer. */ /* diff --git a/cpukit/score/src/wkspacemallocinitunified.c b/cpukit/score/src/wkspacemallocinitunified.c index 6aba1ff0a5..d21ef22d19 100644 --- a/cpukit/score/src/wkspacemallocinitunified.c +++ b/cpukit/score/src/wkspacemallocinitunified.c @@ -5,7 +5,7 @@ * * @ingroup RTEMSScoreWorkspace * - * @brief This source file provides the implementation of + * @brief This source file contains the implementation of * _Workspace_Malloc_initialize_unified(). */ diff --git a/cpukit/score/src/wkstringduplicate.c b/cpukit/score/src/wkstringduplicate.c index 5c0b0877f1..180369f1a8 100644 --- a/cpukit/score/src/wkstringduplicate.c +++ b/cpukit/score/src/wkstringduplicate.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Duplicates String with Memory from the Workspace - * * @ingroup RTEMSScoreWorkspace + * + * @brief This source file contains the implementation of + * _Workspace_String_duplicate(). */ /* |