summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-26 11:45:47 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-12-02 07:45:53 +0100
commit6b5f22dcbb4a876080a3713233e4d5a23d6383ed (patch)
tree9d509ea5c1b34eb06d728eeb95423fd7f3eefc1f /cpukit/include/rtems
parentscore: Always define RTEMSScoreMRSP group (diff)
downloadrtems-6b5f22dcbb4a876080a3713233e4d5a23d6383ed.tar.bz2
rtems: Canonicalize Doxygen @file comments
Use common phrases for the file brief descriptions. Update #3706.
Diffstat (limited to 'cpukit/include/rtems')
-rw-r--r--cpukit/include/rtems/rtems/asrimpl.h3
-rw-r--r--cpukit/include/rtems/rtems/attrimpl.h3
-rw-r--r--cpukit/include/rtems/rtems/barrierimpl.h3
-rw-r--r--cpukit/include/rtems/rtems/clockimpl.h4
-rw-r--r--cpukit/include/rtems/rtems/dpmemimpl.h3
-rw-r--r--cpukit/include/rtems/rtems/eventimpl.h3
-rw-r--r--cpukit/include/rtems/rtems/eventmp.h4
-rw-r--r--cpukit/include/rtems/rtems/messageimpl.h3
-rw-r--r--cpukit/include/rtems/rtems/modesimpl.h3
-rw-r--r--cpukit/include/rtems/rtems/mp.h7
-rw-r--r--cpukit/include/rtems/rtems/msgmp.h6
-rw-r--r--cpukit/include/rtems/rtems/objectimpl.h3
-rw-r--r--cpukit/include/rtems/rtems/optionsimpl.h3
-rw-r--r--cpukit/include/rtems/rtems/partimpl.h4
-rw-r--r--cpukit/include/rtems/rtems/partmp.h6
-rw-r--r--cpukit/include/rtems/rtems/ratemonimpl.h3
-rw-r--r--cpukit/include/rtems/rtems/regionimpl.h3
-rw-r--r--cpukit/include/rtems/rtems/semimpl.h3
-rw-r--r--cpukit/include/rtems/rtems/semmp.h4
-rw-r--r--cpukit/include/rtems/rtems/signalimpl.h3
-rw-r--r--cpukit/include/rtems/rtems/signalmp.h4
-rw-r--r--cpukit/include/rtems/rtems/statusimpl.h3
-rw-r--r--cpukit/include/rtems/rtems/taskmp.h4
-rw-r--r--cpukit/include/rtems/rtems/tasksimpl.h3
-rw-r--r--cpukit/include/rtems/rtems/timerimpl.h3
25 files changed, 51 insertions, 40 deletions
diff --git a/cpukit/include/rtems/rtems/asrimpl.h b/cpukit/include/rtems/rtems/asrimpl.h
index f007457fe5..e9369079e6 100644
--- a/cpukit/include/rtems/rtems/asrimpl.h
+++ b/cpukit/include/rtems/rtems/asrimpl.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicASR
*
- * @brief Classic ASR Implementation
+ * @brief This header file provides the implementation interfaces of
+ * the @ref RTEMSImplClassicASR support.
*/
/* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/include/rtems/rtems/attrimpl.h b/cpukit/include/rtems/rtems/attrimpl.h
index 3b19c67387..a41b3ad89b 100644
--- a/cpukit/include/rtems/rtems/attrimpl.h
+++ b/cpukit/include/rtems/rtems/attrimpl.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicAttr
*
- * @brief Classic Attributes Implementation
+ * @brief This header file provides the implementation interfaces of
+ * the @ref RTEMSImplClassicAttr support.
*/
/*
diff --git a/cpukit/include/rtems/rtems/barrierimpl.h b/cpukit/include/rtems/rtems/barrierimpl.h
index 0cee8e4d74..5f96273f89 100644
--- a/cpukit/include/rtems/rtems/barrierimpl.h
+++ b/cpukit/include/rtems/rtems/barrierimpl.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicBarrier
*
- * @brief Classic Barrier Manager Implementation
+ * @brief This header file provides the implementation interfaces of
+ * the @ref RTEMSImplClassicBarrier.
*/
/*
diff --git a/cpukit/include/rtems/rtems/clockimpl.h b/cpukit/include/rtems/rtems/clockimpl.h
index eff1231fb2..c13c158410 100644
--- a/cpukit/include/rtems/rtems/clockimpl.h
+++ b/cpukit/include/rtems/rtems/clockimpl.h
@@ -3,8 +3,8 @@
*
* @ingroup RTEMSImplClassicClock
*
- * @brief This header file provides interfaces used by the Clock Manager
- * implementation.
+ * @brief This header file provides the implementation interfaces of
+ * the @ref RTEMSImplClassicClock.
*/
/* COPYRIGHT (c) 1989-2013.
diff --git a/cpukit/include/rtems/rtems/dpmemimpl.h b/cpukit/include/rtems/rtems/dpmemimpl.h
index 54324d6016..a399eccd94 100644
--- a/cpukit/include/rtems/rtems/dpmemimpl.h
+++ b/cpukit/include/rtems/rtems/dpmemimpl.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicDPMem
*
- * @brief Dual Ported Memory Manager Implementation
+ * @brief This header file provides the implementation interfaces of
+ * the @ref RTEMSImplClassicDPMem
*/
/* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/include/rtems/rtems/eventimpl.h b/cpukit/include/rtems/rtems/eventimpl.h
index 9e4f5cfa74..bd90554455 100644
--- a/cpukit/include/rtems/rtems/eventimpl.h
+++ b/cpukit/include/rtems/rtems/eventimpl.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicEvent
*
- * @brief This header file provides interfaces used by the event implementation.
+ * @brief This header file provides the implementation interfaces of
+ * the @ref RTEMSImplClassicEvent.
*/
/* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/include/rtems/rtems/eventmp.h b/cpukit/include/rtems/rtems/eventmp.h
index acf1cf8eb8..e8c77cac24 100644
--- a/cpukit/include/rtems/rtems/eventmp.h
+++ b/cpukit/include/rtems/rtems/eventmp.h
@@ -3,8 +3,8 @@
*
* @ingroup RTEMSImplClassicEventMP
*
- * This include file contains all the constants and structures associated
- * with the Multiprocessing Support in the Event Manager.
+ * @brief This header file provides the implementation interfaces of the
+ * @ref RTEMSImplClassicEventMP.
*/
/* COPYRIGHT (c) 1989-2013.
diff --git a/cpukit/include/rtems/rtems/messageimpl.h b/cpukit/include/rtems/rtems/messageimpl.h
index 063a51e558..b9cdd0251d 100644
--- a/cpukit/include/rtems/rtems/messageimpl.h
+++ b/cpukit/include/rtems/rtems/messageimpl.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicMessage
*
- * @brief Classic Message Queue Manager Implementation
+ * @brief This header file provides the implementation interfaces of
+ * the @ref RTEMSImplClassicMessage.
*/
/* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/include/rtems/rtems/modesimpl.h b/cpukit/include/rtems/rtems/modesimpl.h
index 43e3fcb4d7..5a147b10b9 100644
--- a/cpukit/include/rtems/rtems/modesimpl.h
+++ b/cpukit/include/rtems/rtems/modesimpl.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicModes
*
- * @brief Classic Modes Implementation
+ * @brief This header file provides the implementation interfaces of
+ * the @ref RTEMSImplClassicModes support.
*/
/* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/include/rtems/rtems/mp.h b/cpukit/include/rtems/rtems/mp.h
index 0ddeaf7d53..2f2cd822f8 100644
--- a/cpukit/include/rtems/rtems/mp.h
+++ b/cpukit/include/rtems/rtems/mp.h
@@ -1,10 +1,9 @@
/**
* @file
*
- * @ingroup ClassicMP
+ * @ingroup RTEMSImplClassic
*
- * This include file contains all the constants and structures associated
- * with the Multiprocessing Manager.
+ * @brief This header file provides parts of the multiprocessing (MP) API.
*/
/* COPYRIGHT (c) 1989-2013.
@@ -21,7 +20,7 @@
#include <rtems/score/mppkt.h>
/**
- * @defgroup ClassicMP Multiprocessing
+ * @defgroup RTEMSAPIClassicMP Multiprocessing
*
* @ingroup RTEMSAPIClassic
*
diff --git a/cpukit/include/rtems/rtems/msgmp.h b/cpukit/include/rtems/rtems/msgmp.h
index 3b62224e03..a5f5ae8011 100644
--- a/cpukit/include/rtems/rtems/msgmp.h
+++ b/cpukit/include/rtems/rtems/msgmp.h
@@ -3,10 +3,8 @@
*
* @ingroup RTEMSImplClassicMessageMP
*
- * @brief Message Manager MP Support
- *
- * This include file contains all the constants and structures associated
- * with the Multiprocessing Support in the Message Manager.
+ * @brief This header file provides the implementation interfaces of the
+ * @ref RTEMSImplClassicMessageMP.
*/
/* COPYRIGHT (c) 1989-2013.
diff --git a/cpukit/include/rtems/rtems/objectimpl.h b/cpukit/include/rtems/rtems/objectimpl.h
index ada2a5a4cb..fc93d1aa3b 100644
--- a/cpukit/include/rtems/rtems/objectimpl.h
+++ b/cpukit/include/rtems/rtems/objectimpl.h
@@ -5,7 +5,8 @@
*
* @ingroup RTEMSImplClassicObject
*
- * @brief Implementation Interfaces for Classic Objects
+ * @brief This header file provides the implementation interfaces of
+ * the @ref RTEMSImplClassicObject.
*/
/*
diff --git a/cpukit/include/rtems/rtems/optionsimpl.h b/cpukit/include/rtems/rtems/optionsimpl.h
index 3f08978515..7130b2c31f 100644
--- a/cpukit/include/rtems/rtems/optionsimpl.h
+++ b/cpukit/include/rtems/rtems/optionsimpl.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicOptions
*
- * @brief Classic Options Implementation
+ * @brief This header file provides the implementation interfaces of
+ * the @ref RTEMSImplClassicOptions support.
*/
/* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/include/rtems/rtems/partimpl.h b/cpukit/include/rtems/rtems/partimpl.h
index 3e2b1e759e..144265df7d 100644
--- a/cpukit/include/rtems/rtems/partimpl.h
+++ b/cpukit/include/rtems/rtems/partimpl.h
@@ -3,8 +3,8 @@
*
* @ingroup RTEMSImplClassicPartition
*
- * @brief This header file provides interfaces used by the Partition Manager
- * implementation.
+ * @brief This header file provides the implementation interfaces of
+ * the @ref RTEMSImplClassicPartition.
*/
/* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/include/rtems/rtems/partmp.h b/cpukit/include/rtems/rtems/partmp.h
index 5e2ed77285..103a28f9d5 100644
--- a/cpukit/include/rtems/rtems/partmp.h
+++ b/cpukit/include/rtems/rtems/partmp.h
@@ -3,10 +3,8 @@
*
* @ingroup RTEMSImplClassicPartitionMP
*
- * @brief MP Support in Partition Manager
- *
- * This include file contains all the constants and structures associated
- * with the Multiprocessing Support in the Partition Manager.
+ * @brief This header file provides the implementation interfaces of the
+ * @ref RTEMSImplClassicPartitionMP.
*/
/* COPYRIGHT (c) 1989-2013.
diff --git a/cpukit/include/rtems/rtems/ratemonimpl.h b/cpukit/include/rtems/rtems/ratemonimpl.h
index 998fa386bf..7e42a0437c 100644
--- a/cpukit/include/rtems/rtems/ratemonimpl.h
+++ b/cpukit/include/rtems/rtems/ratemonimpl.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicRateMonotonic
*
- * @brief Classic Rate Monotonic Scheduler Implementation
+ * @brief This header file provides the implementation interfaces of
+ * the @ref RTEMSImplClassicRateMonotonic.
*/
/* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/include/rtems/rtems/regionimpl.h b/cpukit/include/rtems/rtems/regionimpl.h
index 418d5d052d..85facea5e7 100644
--- a/cpukit/include/rtems/rtems/regionimpl.h
+++ b/cpukit/include/rtems/rtems/regionimpl.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicRegion
*
- * @brief Classic Region Manager Implementation
+ * @brief This header file provides the implementation interfaces of
+ * the @ref RTEMSImplClassicRegion.
*/
/* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/include/rtems/rtems/semimpl.h b/cpukit/include/rtems/rtems/semimpl.h
index c84c3d2a76..2f76d73d16 100644
--- a/cpukit/include/rtems/rtems/semimpl.h
+++ b/cpukit/include/rtems/rtems/semimpl.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicSemaphore
*
- * @brief Classic Semaphore Manager Implementation
+ * @brief This header file provides the implementation interfaces of
+ * the @ref RTEMSImplClassicSemaphore.
*/
/* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/include/rtems/rtems/semmp.h b/cpukit/include/rtems/rtems/semmp.h
index a516b111e2..e69d338ddd 100644
--- a/cpukit/include/rtems/rtems/semmp.h
+++ b/cpukit/include/rtems/rtems/semmp.h
@@ -3,8 +3,8 @@
*
* @ingroup RTEMSImplClassicSemaphoreMP
*
- * This include file contains all the constants and structures associated
- * with the Multiprocessing Support in the Semaphore Manager.
+ * @brief This header file provides the implementation interfaces of the
+ * @ref RTEMSImplClassicSemaphoreMP.
*/
/* COPYRIGHT (c) 1989-2013.
diff --git a/cpukit/include/rtems/rtems/signalimpl.h b/cpukit/include/rtems/rtems/signalimpl.h
index 282b29fb48..51f742c9fe 100644
--- a/cpukit/include/rtems/rtems/signalimpl.h
+++ b/cpukit/include/rtems/rtems/signalimpl.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicSignal
*
- * @brief Signals Implementation
+ * @brief This header file provides the implementation interfaces of
+ * the @ref RTEMSImplClassicSignal.
*/
/* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/include/rtems/rtems/signalmp.h b/cpukit/include/rtems/rtems/signalmp.h
index 240a271755..8e1fb06003 100644
--- a/cpukit/include/rtems/rtems/signalmp.h
+++ b/cpukit/include/rtems/rtems/signalmp.h
@@ -3,8 +3,8 @@
*
* @ingroup RTEMSImplClassicSignalMP
*
- * This include file contains all the constants and structures associated
- * with the Multiprocessing Support in the Signal Manager.
+ * @brief This header file provides the implementation interfaces of the
+ * @ref RTEMSImplClassicSignalMP.
*/
/* COPYRIGHT (c) 1989-2013.
diff --git a/cpukit/include/rtems/rtems/statusimpl.h b/cpukit/include/rtems/rtems/statusimpl.h
index fc67fb6768..070c612202 100644
--- a/cpukit/include/rtems/rtems/statusimpl.h
+++ b/cpukit/include/rtems/rtems/statusimpl.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicStatus
*
- * @brief Classic Status Implementation
+ * @brief This header file provides the implementation interfaces of
+ * the @ref RTEMSImplClassicStatus support.
*/
/* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/include/rtems/rtems/taskmp.h b/cpukit/include/rtems/rtems/taskmp.h
index d0f4b6f6ee..d991df0c51 100644
--- a/cpukit/include/rtems/rtems/taskmp.h
+++ b/cpukit/include/rtems/rtems/taskmp.h
@@ -3,8 +3,8 @@
*
* @ingroup RTEMSImplClassicTaskMP
*
- * This include file contains all the constants and structures associated
- * with the multiprocessing support in the task manager.
+ * @brief This header file provides the implementation interfaces of the
+ * @ref RTEMSImplClassicTaskMP.
*/
/* COPYRIGHT (c) 1989-2013.
diff --git a/cpukit/include/rtems/rtems/tasksimpl.h b/cpukit/include/rtems/rtems/tasksimpl.h
index fc9d1e04f8..eac4647897 100644
--- a/cpukit/include/rtems/rtems/tasksimpl.h
+++ b/cpukit/include/rtems/rtems/tasksimpl.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicTask
*
- * @brief Classic Tasks Manager Implementation
+ * @brief This header file provides the implementation interfaces of
+ * the @ref RTEMSImplClassicTask.
*/
/* COPYRIGHT (c) 1989-2014.
diff --git a/cpukit/include/rtems/rtems/timerimpl.h b/cpukit/include/rtems/rtems/timerimpl.h
index 5305aa064a..c441a040e6 100644
--- a/cpukit/include/rtems/rtems/timerimpl.h
+++ b/cpukit/include/rtems/rtems/timerimpl.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicTimer
*
- * @brief Classic Timer Implementation
+ * @brief This header file provides the implementation interfaces of
+ * the @ref RTEMSImplClassicTimer.
*/
/*