summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/score
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-27 17:21:23 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-12-02 07:45:53 +0100
commit9278f3d04f1e26071cb98a5e2940177abc40b6d8 (patch)
tree9f5d198e4af5ad22b96012a17ce0a23769acf01f /cpukit/include/rtems/score
parentrtems: Canonicalize Doxygen @file comments (diff)
downloadrtems-9278f3d04f1e26071cb98a5e2940177abc40b6d8.tar.bz2
score: Canonicalize Doxygen @file comments
Use common phrases for the file brief descriptions. Update #3706.
Diffstat (limited to 'cpukit/include/rtems/score')
-rw-r--r--cpukit/include/rtems/score/address.h6
-rw-r--r--cpukit/include/rtems/score/apimutex.h3
-rw-r--r--cpukit/include/rtems/score/assert.h3
-rw-r--r--cpukit/include/rtems/score/atomic.h3
-rw-r--r--cpukit/include/rtems/score/chain.h3
-rw-r--r--cpukit/include/rtems/score/chainimpl.h5
-rw-r--r--cpukit/include/rtems/score/context.h5
-rw-r--r--cpukit/include/rtems/score/copyrt.h6
-rw-r--r--cpukit/include/rtems/score/corebarrier.h7
-rw-r--r--cpukit/include/rtems/score/corebarrierimpl.h6
-rw-r--r--cpukit/include/rtems/score/coremsg.h6
-rw-r--r--cpukit/include/rtems/score/coremsgbuffer.h5
-rw-r--r--cpukit/include/rtems/score/coremsgimpl.h7
-rw-r--r--cpukit/include/rtems/score/coremutex.h13
-rw-r--r--cpukit/include/rtems/score/coremuteximpl.h3
-rw-r--r--cpukit/include/rtems/score/corerwlockimpl.h6
-rw-r--r--cpukit/include/rtems/score/coresem.h9
-rw-r--r--cpukit/include/rtems/score/coresemimpl.h6
-rw-r--r--cpukit/include/rtems/score/cpustdatomic.h3
-rw-r--r--cpukit/include/rtems/score/freechain.h5
-rw-r--r--cpukit/include/rtems/score/freechainimpl.h4
-rw-r--r--cpukit/include/rtems/score/heap.h4
-rw-r--r--cpukit/include/rtems/score/heapimpl.h3
-rw-r--r--cpukit/include/rtems/score/heapinfo.h3
-rw-r--r--cpukit/include/rtems/score/interr.h6
-rw-r--r--cpukit/include/rtems/score/io.h9
-rw-r--r--cpukit/include/rtems/score/isr.h12
-rw-r--r--cpukit/include/rtems/score/isrlevel.h6
-rw-r--r--cpukit/include/rtems/score/isrlock.h3
-rw-r--r--cpukit/include/rtems/score/memory.h3
-rw-r--r--cpukit/include/rtems/score/mpci.h4
-rw-r--r--cpukit/include/rtems/score/mpciimpl.h3
-rw-r--r--cpukit/include/rtems/score/mppkt.h13
-rw-r--r--cpukit/include/rtems/score/mrsp.h4
-rw-r--r--cpukit/include/rtems/score/mrspimpl.h3
-rw-r--r--cpukit/include/rtems/score/muteximpl.h25
-rw-r--r--cpukit/include/rtems/score/object.h11
-rw-r--r--cpukit/include/rtems/score/objectimpl.h6
-rw-r--r--cpukit/include/rtems/score/objectmp.h6
-rw-r--r--cpukit/include/rtems/score/onceimpl.h3
-rw-r--r--cpukit/include/rtems/score/percpu.h8
-rw-r--r--cpukit/include/rtems/score/percpudata.h3
-rw-r--r--cpukit/include/rtems/score/priority.h4
-rw-r--r--cpukit/include/rtems/score/prioritybitmap.h7
-rw-r--r--cpukit/include/rtems/score/prioritybitmapimpl.h6
-rw-r--r--cpukit/include/rtems/score/priorityimpl.h3
-rw-r--r--cpukit/include/rtems/score/processormask.h5
-rw-r--r--cpukit/include/rtems/score/profiling.h3
-rw-r--r--cpukit/include/rtems/score/protectedheap.h3
-rw-r--r--cpukit/include/rtems/score/rbtree.h7
-rw-r--r--cpukit/include/rtems/score/rbtreeimpl.h10
-rw-r--r--cpukit/include/rtems/score/scheduler.h7
-rw-r--r--cpukit/include/rtems/score/schedulercbs.h7
-rw-r--r--cpukit/include/rtems/score/schedulercbsimpl.h5
-rw-r--r--cpukit/include/rtems/score/scheduleredf.h7
-rw-r--r--cpukit/include/rtems/score/scheduleredfimpl.h3
-rw-r--r--cpukit/include/rtems/score/scheduleredfsmp.h5
-rw-r--r--cpukit/include/rtems/score/schedulerimpl.h6
-rw-r--r--cpukit/include/rtems/score/schedulernode.h4
-rw-r--r--cpukit/include/rtems/score/schedulernodeimpl.h4
-rw-r--r--cpukit/include/rtems/score/schedulerpriority.h7
-rw-r--r--cpukit/include/rtems/score/schedulerpriorityaffinitysmp.h3
-rw-r--r--cpukit/include/rtems/score/schedulerpriorityimpl.h7
-rw-r--r--cpukit/include/rtems/score/schedulerprioritysmp.h4
-rw-r--r--cpukit/include/rtems/score/schedulerprioritysmpimpl.h4
-rw-r--r--cpukit/include/rtems/score/schedulersimple.h7
-rw-r--r--cpukit/include/rtems/score/schedulersimpleimpl.h7
-rw-r--r--cpukit/include/rtems/score/schedulersimplesmp.h3
-rw-r--r--cpukit/include/rtems/score/schedulersmp.h4
-rw-r--r--cpukit/include/rtems/score/schedulersmpimpl.h5
-rw-r--r--cpukit/include/rtems/score/schedulerstrongapa.h3
-rw-r--r--cpukit/include/rtems/score/semaphoreimpl.h13
-rw-r--r--cpukit/include/rtems/score/smp.h4
-rw-r--r--cpukit/include/rtems/score/smpbarrier.h3
-rw-r--r--cpukit/include/rtems/score/smpimpl.h3
-rw-r--r--cpukit/include/rtems/score/smplock.h3
-rw-r--r--cpukit/include/rtems/score/smplockmcs.h3
-rw-r--r--cpukit/include/rtems/score/smplockseq.h3
-rw-r--r--cpukit/include/rtems/score/smplockstats.h3
-rw-r--r--cpukit/include/rtems/score/smplockticket.h3
-rw-r--r--cpukit/include/rtems/score/stack.h11
-rw-r--r--cpukit/include/rtems/score/stackimpl.h6
-rw-r--r--cpukit/include/rtems/score/states.h6
-rw-r--r--cpukit/include/rtems/score/statesimpl.h6
-rw-r--r--cpukit/include/rtems/score/status.h21
-rw-r--r--cpukit/include/rtems/score/sysstate.h3
-rw-r--r--cpukit/include/rtems/score/thread.h7
-rw-r--r--cpukit/include/rtems/score/threaddispatch.h3
-rw-r--r--cpukit/include/rtems/score/threadimpl.h6
-rw-r--r--cpukit/include/rtems/score/threadmp.h6
-rw-r--r--cpukit/include/rtems/score/threadq.h7
-rw-r--r--cpukit/include/rtems/score/threadqimpl.h12
-rw-r--r--cpukit/include/rtems/score/timecounter.h3
-rw-r--r--cpukit/include/rtems/score/timecounterimpl.h3
-rw-r--r--cpukit/include/rtems/score/timespec.h3
-rw-r--r--cpukit/include/rtems/score/timestamp.h6
-rw-r--r--cpukit/include/rtems/score/timestampimpl.h5
-rw-r--r--cpukit/include/rtems/score/tls.h3
-rw-r--r--cpukit/include/rtems/score/todimpl.h4
-rw-r--r--cpukit/include/rtems/score/userext.h4
-rw-r--r--cpukit/include/rtems/score/userextimpl.h3
-rw-r--r--cpukit/include/rtems/score/watchdog.h12
-rw-r--r--cpukit/include/rtems/score/watchdogimpl.h6
-rw-r--r--cpukit/include/rtems/score/watchdogticks.h4
-rw-r--r--cpukit/include/rtems/score/wkspace.h10
105 files changed, 326 insertions, 274 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.
*
* @{
*/