summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/rtems
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-30 14:00:08 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-12-02 07:45:53 +0100
commit70dbafbf5ed26d0d434d6428d9f3de1be2ee502a (patch)
tree872ccc19606d492beddbdc2875a2ef79d8d8bcf0 /cpukit/include/rtems/rtems
parentsapi: Canonicalize @defgroup and @file comments (diff)
downloadrtems-70dbafbf5ed26d0d434d6428d9f3de1be2ee502a.tar.bz2
config: Canonicalize @defgroup and @file comments
Adjust group identifier and names to be in line with a common pattern. Use common phrases for the group and file brief descriptions. Update #3706.
Diffstat (limited to 'cpukit/include/rtems/rtems')
-rw-r--r--cpukit/include/rtems/rtems/asrdata.h4
-rw-r--r--cpukit/include/rtems/rtems/barrierdata.h3
-rw-r--r--cpukit/include/rtems/rtems/dpmemdata.h4
-rw-r--r--cpukit/include/rtems/rtems/eventdata.h5
-rw-r--r--cpukit/include/rtems/rtems/messagedata.h5
-rw-r--r--cpukit/include/rtems/rtems/partdata.h4
-rw-r--r--cpukit/include/rtems/rtems/ratemondata.h3
-rw-r--r--cpukit/include/rtems/rtems/regiondata.h3
-rw-r--r--cpukit/include/rtems/rtems/semdata.h3
-rw-r--r--cpukit/include/rtems/rtems/tasksdata.h5
-rw-r--r--cpukit/include/rtems/rtems/timerdata.h3
11 files changed, 28 insertions, 14 deletions
diff --git a/cpukit/include/rtems/rtems/asrdata.h b/cpukit/include/rtems/rtems/asrdata.h
index 2ff1ac87c0..caf29a0863 100644
--- a/cpukit/include/rtems/rtems/asrdata.h
+++ b/cpukit/include/rtems/rtems/asrdata.h
@@ -3,7 +3,9 @@
*
* @ingroup RTEMSImplClassicASR
*
- * @brief Classic ASR Data Structures
+ * @brief This header file provides data structures used by the implementation
+ * and the @ref RTEMSImplApplConfig to ultimately define
+ * ::Thread_Configured_control.
*/
/* COPYRIGHT (c) 1989-2013.
diff --git a/cpukit/include/rtems/rtems/barrierdata.h b/cpukit/include/rtems/rtems/barrierdata.h
index 256afddf30..b449186a59 100644
--- a/cpukit/include/rtems/rtems/barrierdata.h
+++ b/cpukit/include/rtems/rtems/barrierdata.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicBarrier
*
- * @brief Classic Barrier Manager Data Structures
+ * @brief This header file provides data structures used by the implementation
+ * and the @ref RTEMSImplApplConfig to define ::_Barrier_Information.
*/
diff --git a/cpukit/include/rtems/rtems/dpmemdata.h b/cpukit/include/rtems/rtems/dpmemdata.h
index ce4cf2dbf6..5303b8623a 100644
--- a/cpukit/include/rtems/rtems/dpmemdata.h
+++ b/cpukit/include/rtems/rtems/dpmemdata.h
@@ -3,7 +3,9 @@
*
* @ingroup RTEMSImplClassicDPMem
*
- * @brief Classic Dual Ported Memory Manager Data Structures
+ * @brief This header file provides data structures used by the implementation
+ * and the @ref RTEMSImplApplConfig to define
+ * ::_Dual_ported_memory_Information.
*/
/* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/include/rtems/rtems/eventdata.h b/cpukit/include/rtems/rtems/eventdata.h
index 650c3d544a..7078cc2248 100644
--- a/cpukit/include/rtems/rtems/eventdata.h
+++ b/cpukit/include/rtems/rtems/eventdata.h
@@ -3,8 +3,9 @@
*
* @ingroup RTEMSImplClassicEvent
*
- * @brief This header file provides the API used by the Application
- * Configuration to define the configured Thread Control Block (TCB).
+ * @brief This header file provides data structures used by the implementation
+ * and the @ref RTEMSImplApplConfig to ultimately define
+ * ::Thread_Configured_control.
*/
/* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/include/rtems/rtems/messagedata.h b/cpukit/include/rtems/rtems/messagedata.h
index 83c3fcae87..ed74abf981 100644
--- a/cpukit/include/rtems/rtems/messagedata.h
+++ b/cpukit/include/rtems/rtems/messagedata.h
@@ -1,9 +1,10 @@
/**
* @file
*
- * @ingroup ClassicMessageQueue
+ * @ingroup RTEMSImplClassicMessage
*
- * @brief Classic Message Queue Manager API
+ * @brief This header file provides data structures used by the implementation
+ * and the @ref RTEMSImplApplConfig to define ::_Message_queue_Information.
*/
/* COPYRIGHT (c) 1989-2013.
diff --git a/cpukit/include/rtems/rtems/partdata.h b/cpukit/include/rtems/rtems/partdata.h
index 59daf5f002..73babd36f4 100644
--- a/cpukit/include/rtems/rtems/partdata.h
+++ b/cpukit/include/rtems/rtems/partdata.h
@@ -3,8 +3,8 @@
*
* @ingroup RTEMSImplClassicPartition
*
- * @brief This header file provides the API used by the Application
- * Configuration to define the Partition Manager information.
+ * @brief This header file provides data structures used by the implementation
+ * and the @ref RTEMSImplApplConfig to define ::_Partition_Information.
*/
/* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/include/rtems/rtems/ratemondata.h b/cpukit/include/rtems/rtems/ratemondata.h
index 3fd59e8986..f35fa7eb61 100644
--- a/cpukit/include/rtems/rtems/ratemondata.h
+++ b/cpukit/include/rtems/rtems/ratemondata.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicRateMonotonic
*
- * @brief Classic Rate Monotonic Scheduler Data Structures
+ * @brief This header file provides data structures used by the implementation
+ * and the @ref RTEMSImplApplConfig to define ::_Rate_monotonic_Information.
*/
/* COPYRIGHT (c) 1989-2009, 2016.
diff --git a/cpukit/include/rtems/rtems/regiondata.h b/cpukit/include/rtems/rtems/regiondata.h
index 71cd833377..5852f4cb45 100644
--- a/cpukit/include/rtems/rtems/regiondata.h
+++ b/cpukit/include/rtems/rtems/regiondata.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicRegion
*
- * @brief Classic Region Manager Data Structures
+ * @brief This header file provides data structures used by the implementation
+ * and the @ref RTEMSImplApplConfig to define ::_Region_Information.
*/
/* COPYRIGHT (c) 1989-2013.
diff --git a/cpukit/include/rtems/rtems/semdata.h b/cpukit/include/rtems/rtems/semdata.h
index e780ff40d7..2612f1a902 100644
--- a/cpukit/include/rtems/rtems/semdata.h
+++ b/cpukit/include/rtems/rtems/semdata.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicSemaphore
*
- * @brief Classic Semaphore Manager Data Structures
+ * @brief This header file provides data structures used by the implementation
+ * and the @ref RTEMSImplApplConfig to define ::_Semaphore_Information.
*/
/*
diff --git a/cpukit/include/rtems/rtems/tasksdata.h b/cpukit/include/rtems/rtems/tasksdata.h
index ff9fceb1d9..fb15453e65 100644
--- a/cpukit/include/rtems/rtems/tasksdata.h
+++ b/cpukit/include/rtems/rtems/tasksdata.h
@@ -3,7 +3,10 @@
*
* @ingroup RTEMSImplClassicTask
*
- * @brief Classic Tasks Manager Data Structures
+ * @brief This header file provides data structures used by the implementation
+ * and the @ref RTEMSImplApplConfig to define the
+ * ::_RTEMS_tasks_User_task_table, the ::_RTEMS_tasks_User_task_config,
+ * ::_RTEMS_tasks_Information, and ultimately ::Thread_Configured_control.
*/
/*
diff --git a/cpukit/include/rtems/rtems/timerdata.h b/cpukit/include/rtems/rtems/timerdata.h
index 6edbad2ba8..2a7cc03cb1 100644
--- a/cpukit/include/rtems/rtems/timerdata.h
+++ b/cpukit/include/rtems/rtems/timerdata.h
@@ -3,7 +3,8 @@
*
* @ingroup RTEMSImplClassicTimer
*
- * @brief Classic Partition Manager Data Structures
+ * @brief This header file provides data structures used by the implementation
+ * and the @ref RTEMSImplApplConfig to define ::_Timer_Information.
*/
/*