[PATCH 01/20] doxygen: Rename Internal to Implementation
Sebastian Huber
sebastian.huber at embedded-brains.de
Fri Nov 20 11:15:07 UTC 2020
Use a top-level implementation group to gather implementation related
files. The use of "Impl" is shorter and matches with the *impl.h file
names.
---
cpukit/doxygen.h | 4 ++--
cpukit/doxygen/top-level-groups.h | 4 ++--
cpukit/include/rtems/confdefs.h | 2 +-
cpukit/include/rtems/extensionimpl.h | 2 +-
cpukit/include/rtems/libcsupport.h | 2 +-
cpukit/include/rtems/posix/posixapi.h | 2 +-
cpukit/include/rtems/rtems/asrimpl.h | 2 +-
cpukit/include/rtems/rtems/attrimpl.h | 2 +-
cpukit/include/rtems/rtems/barrierimpl.h | 2 +-
cpukit/include/rtems/rtems/dpmemimpl.h | 2 +-
cpukit/include/rtems/rtems/eventimpl.h | 2 +-
cpukit/include/rtems/rtems/messageimpl.h | 2 +-
cpukit/include/rtems/rtems/modesimpl.h | 2 +-
cpukit/include/rtems/rtems/objectimpl.h | 2 +-
cpukit/include/rtems/rtems/optionsimpl.h | 2 +-
cpukit/include/rtems/rtems/partimpl.h | 2 +-
cpukit/include/rtems/rtems/ratemonimpl.h | 2 +-
cpukit/include/rtems/rtems/regionimpl.h | 2 +-
cpukit/include/rtems/rtems/semimpl.h | 2 +-
cpukit/include/rtems/rtems/signalimpl.h | 2 +-
cpukit/include/rtems/rtems/statusimpl.h | 2 +-
cpukit/include/rtems/rtems/tasksimpl.h | 2 +-
cpukit/include/rtems/rtems/timerimpl.h | 2 +-
cpukit/include/rtems/score/object.h | 2 +-
24 files changed, 26 insertions(+), 26 deletions(-)
diff --git a/cpukit/doxygen.h b/cpukit/doxygen.h
index c159b2082d..0428424476 100644
--- a/cpukit/doxygen.h
+++ b/cpukit/doxygen.h
@@ -1,7 +1,7 @@
/**
- * @defgroup RTEMSInternalClassic Classic
+ * @defgroup RTEMSImplClassic Classic
*
- * @ingroup RTEMSInternal
+ * @ingroup RTEMSImpl
*
* @brief Classic
*/
diff --git a/cpukit/doxygen/top-level-groups.h b/cpukit/doxygen/top-level-groups.h
index c1a91a3482..2916ec0b90 100644
--- a/cpukit/doxygen/top-level-groups.h
+++ b/cpukit/doxygen/top-level-groups.h
@@ -38,9 +38,9 @@
*/
/**
- * @defgroup RTEMSInternal Internal
+ * @defgroup RTEMSImpl Implementation
*
- * @brief RTEMS Implementation.
+ * @brief This group contains the RTEMS implementation components.
*/
/**
diff --git a/cpukit/include/rtems/confdefs.h b/cpukit/include/rtems/confdefs.h
index b53ed0b83b..fb4a7b9800 100644
--- a/cpukit/include/rtems/confdefs.h
+++ b/cpukit/include/rtems/confdefs.h
@@ -45,7 +45,7 @@
/**
* @defgroup RTEMSApplicationConfiguration Application Configuration
*
- * @ingroup RTEMSInternal
+ * @ingroup RTEMSImpl
*
* @brief Evaluation of Application Configuration Options
*
diff --git a/cpukit/include/rtems/extensionimpl.h b/cpukit/include/rtems/extensionimpl.h
index 12d0bb656f..ed9da1fa28 100644
--- a/cpukit/include/rtems/extensionimpl.h
+++ b/cpukit/include/rtems/extensionimpl.h
@@ -28,7 +28,7 @@ extern "C" {
/**
* @defgroup ClassicUserExtensionsImpl User Extensions Implementation
*
- * @ingroup RTEMSInternalClassic
+ * @ingroup RTEMSImplClassic
*
* @{
*/
diff --git a/cpukit/include/rtems/libcsupport.h b/cpukit/include/rtems/libcsupport.h
index 1300b5f61f..f4be4cfc9a 100644
--- a/cpukit/include/rtems/libcsupport.h
+++ b/cpukit/include/rtems/libcsupport.h
@@ -32,7 +32,7 @@ extern "C" {
/**
* @defgroup libcsupport Standard C Library Support
*
- * @ingroup RTEMSInternal
+ * @ingroup RTEMSImpl
*
* @brief RTEMS Specific Support for the Standard C Library
*
diff --git a/cpukit/include/rtems/posix/posixapi.h b/cpukit/include/rtems/posix/posixapi.h
index 561a56389f..fc669afb45 100644
--- a/cpukit/include/rtems/posix/posixapi.h
+++ b/cpukit/include/rtems/posix/posixapi.h
@@ -30,7 +30,7 @@
/**
* @defgroup POSIXAPI RTEMS POSIX API
*
- * @ingroup RTEMSInternal
+ * @ingroup RTEMSImpl
*
* RTEMS POSIX API definitions and modules.
*
diff --git a/cpukit/include/rtems/rtems/asrimpl.h b/cpukit/include/rtems/rtems/asrimpl.h
index 90910cabc4..e940cbbf5f 100644
--- a/cpukit/include/rtems/rtems/asrimpl.h
+++ b/cpukit/include/rtems/rtems/asrimpl.h
@@ -28,7 +28,7 @@ extern "C" {
/**
* @defgroup ClassicASRImpl Classic ASR Implementation
*
- * @ingroup RTEMSInternalClassic
+ * @ingroup RTEMSImplClassic
*
* @{
*/
diff --git a/cpukit/include/rtems/rtems/attrimpl.h b/cpukit/include/rtems/rtems/attrimpl.h
index 071fbccc0f..feb4f1821a 100644
--- a/cpukit/include/rtems/rtems/attrimpl.h
+++ b/cpukit/include/rtems/rtems/attrimpl.h
@@ -28,7 +28,7 @@ extern "C" {
/**
* @defgroup ClassicAttributesImpl Classic Attributes Implementation
*
- * @ingroup RTEMSInternalClassic
+ * @ingroup RTEMSImplClassic
*
* @{
*/
diff --git a/cpukit/include/rtems/rtems/barrierimpl.h b/cpukit/include/rtems/rtems/barrierimpl.h
index fce66b8ff8..fbb4dea507 100644
--- a/cpukit/include/rtems/rtems/barrierimpl.h
+++ b/cpukit/include/rtems/rtems/barrierimpl.h
@@ -29,7 +29,7 @@ extern "C" {
/**
* @defgroup ClassicBarrierImpl Classic Barrier Implementation
*
- * @ingroup RTEMSInternalClassic
+ * @ingroup RTEMSImplClassic
*
* @{
*/
diff --git a/cpukit/include/rtems/rtems/dpmemimpl.h b/cpukit/include/rtems/rtems/dpmemimpl.h
index f8487007e0..ce98b3c5ec 100644
--- a/cpukit/include/rtems/rtems/dpmemimpl.h
+++ b/cpukit/include/rtems/rtems/dpmemimpl.h
@@ -27,7 +27,7 @@ extern "C" {
/**
* @defgroup ClassicDPMEMImpl Dual Ported Memory Manager Implementation
*
- * @ingroup RTEMSInternalClassic
+ * @ingroup RTEMSImplClassic
*
* @{
*/
diff --git a/cpukit/include/rtems/rtems/eventimpl.h b/cpukit/include/rtems/rtems/eventimpl.h
index 1b4ad41320..21a4884493 100644
--- a/cpukit/include/rtems/rtems/eventimpl.h
+++ b/cpukit/include/rtems/rtems/eventimpl.h
@@ -27,7 +27,7 @@ extern "C" {
/**
* @defgroup ClassicEventImpl Classic Event Implementation
*
- * @ingroup RTEMSInternalClassic
+ * @ingroup RTEMSImplClassic
*
* @{
*/
diff --git a/cpukit/include/rtems/rtems/messageimpl.h b/cpukit/include/rtems/rtems/messageimpl.h
index c90ac97da9..a3a38423d1 100644
--- a/cpukit/include/rtems/rtems/messageimpl.h
+++ b/cpukit/include/rtems/rtems/messageimpl.h
@@ -28,7 +28,7 @@ extern "C" {
/**
* @defgroup ClassicMessageQueueImpl Classic Message Queue Implementation
*
- * @ingroup RTEMSInternalClassic
+ * @ingroup RTEMSImplClassic
*
* @{
*/
diff --git a/cpukit/include/rtems/rtems/modesimpl.h b/cpukit/include/rtems/rtems/modesimpl.h
index c1519711e7..e41c4bc93c 100644
--- a/cpukit/include/rtems/rtems/modesimpl.h
+++ b/cpukit/include/rtems/rtems/modesimpl.h
@@ -27,7 +27,7 @@ extern "C" {
/**
* @defgroup ClassicModesImpl Classic Modes Implementation
*
- * @ingroup RTEMSInternalClassic
+ * @ingroup RTEMSImplClassic
*
* @{
*/
diff --git a/cpukit/include/rtems/rtems/objectimpl.h b/cpukit/include/rtems/rtems/objectimpl.h
index 08a9749832..11b6df93ae 100644
--- a/cpukit/include/rtems/rtems/objectimpl.h
+++ b/cpukit/include/rtems/rtems/objectimpl.h
@@ -46,7 +46,7 @@ extern "C" {
/**
* @defgroup ClassicObjectImpl Classic Object Implementation
*
- * @ingroup RTEMSInternalClassic
+ * @ingroup RTEMSImplClassic
*
* @{
*/
diff --git a/cpukit/include/rtems/rtems/optionsimpl.h b/cpukit/include/rtems/rtems/optionsimpl.h
index e841ec2a2e..4d5a877429 100644
--- a/cpukit/include/rtems/rtems/optionsimpl.h
+++ b/cpukit/include/rtems/rtems/optionsimpl.h
@@ -26,7 +26,7 @@ extern "C" {
/**
* @defgroup ClassicOptionsImpl Classic Options Implementation
*
- * @ingroup RTEMSInternalClassic
+ * @ingroup RTEMSImplClassic
*
* @{
*/
diff --git a/cpukit/include/rtems/rtems/partimpl.h b/cpukit/include/rtems/rtems/partimpl.h
index ec26e54cb2..b2bbd90f76 100644
--- a/cpukit/include/rtems/rtems/partimpl.h
+++ b/cpukit/include/rtems/rtems/partimpl.h
@@ -29,7 +29,7 @@ extern "C" {
/**
* @defgroup ClassicPartImpl Classic Partition Manager Implementation
*
- * @ingroup RTEMSInternalClassic
+ * @ingroup RTEMSImplClassic
*
* @{
*/
diff --git a/cpukit/include/rtems/rtems/ratemonimpl.h b/cpukit/include/rtems/rtems/ratemonimpl.h
index 89fd288c41..5e51afdc41 100644
--- a/cpukit/include/rtems/rtems/ratemonimpl.h
+++ b/cpukit/include/rtems/rtems/ratemonimpl.h
@@ -34,7 +34,7 @@ extern "C" {
/**
* @defgroup ClassicRateMonImpl Classic Rate Monotonic Scheduler Implementation
*
- * @ingroup RTEMSInternalClassic
+ * @ingroup RTEMSImplClassic
*
* @{
*/
diff --git a/cpukit/include/rtems/rtems/regionimpl.h b/cpukit/include/rtems/rtems/regionimpl.h
index da94a9b8fb..e9213ce6c7 100644
--- a/cpukit/include/rtems/rtems/regionimpl.h
+++ b/cpukit/include/rtems/rtems/regionimpl.h
@@ -30,7 +30,7 @@ extern "C" {
/**
* @defgroup ClassicRegionImpl Classic Region Manager Implementation
*
- * @ingroup RTEMSInternalClassic
+ * @ingroup RTEMSImplClassic
*
* @{
*/
diff --git a/cpukit/include/rtems/rtems/semimpl.h b/cpukit/include/rtems/rtems/semimpl.h
index 0cb78e35d4..3cf7b9cdaf 100644
--- a/cpukit/include/rtems/rtems/semimpl.h
+++ b/cpukit/include/rtems/rtems/semimpl.h
@@ -29,7 +29,7 @@ extern "C" {
/**
* @defgroup ClassicSemImpl Semaphore Manager Implementation
*
- * @ingroup RTEMSInternalClassic
+ * @ingroup RTEMSImplClassic
*
* @{
*/
diff --git a/cpukit/include/rtems/rtems/signalimpl.h b/cpukit/include/rtems/rtems/signalimpl.h
index 6766868c49..5945398c54 100644
--- a/cpukit/include/rtems/rtems/signalimpl.h
+++ b/cpukit/include/rtems/rtems/signalimpl.h
@@ -27,7 +27,7 @@ extern "C" {
/**
* @defgroup ClassicSignalImpl Signals Implementation
*
- * @ingroup RTEMSInternalClassic
+ * @ingroup RTEMSImplClassic
*/
/**@{*/
diff --git a/cpukit/include/rtems/rtems/statusimpl.h b/cpukit/include/rtems/rtems/statusimpl.h
index 77fe20c55f..77a081be56 100644
--- a/cpukit/include/rtems/rtems/statusimpl.h
+++ b/cpukit/include/rtems/rtems/statusimpl.h
@@ -27,7 +27,7 @@ extern "C" {
/**
* @defgroup ClassicStatusImpl Classic Status Implementation
*
- * @ingroup RTEMSInternalClassic
+ * @ingroup RTEMSImplClassic
*
* @{
*/
diff --git a/cpukit/include/rtems/rtems/tasksimpl.h b/cpukit/include/rtems/rtems/tasksimpl.h
index a0aa252cea..5eb412c46d 100644
--- a/cpukit/include/rtems/rtems/tasksimpl.h
+++ b/cpukit/include/rtems/rtems/tasksimpl.h
@@ -29,7 +29,7 @@ extern "C" {
/**
* @defgroup ClassicTasksImpl Classic Tasks Manager Implementation
*
- * @ingroup RTEMSInternalClassic
+ * @ingroup RTEMSImplClassic
*
* @{
*/
diff --git a/cpukit/include/rtems/rtems/timerimpl.h b/cpukit/include/rtems/rtems/timerimpl.h
index 97487926e5..4dd7951321 100644
--- a/cpukit/include/rtems/rtems/timerimpl.h
+++ b/cpukit/include/rtems/rtems/timerimpl.h
@@ -32,7 +32,7 @@ extern "C" {
/**
* @defgroup ClassicTimerImpl Classic Timer Implementation
*
- * @ingroup RTEMSInternalClassic
+ * @ingroup RTEMSImplClassic
*
* @{
*/
diff --git a/cpukit/include/rtems/score/object.h b/cpukit/include/rtems/score/object.h
index 6c39af6749..ffc896206b 100644
--- a/cpukit/include/rtems/score/object.h
+++ b/cpukit/include/rtems/score/object.h
@@ -32,7 +32,7 @@ extern "C" {
/**
* @defgroup RTEMSScore SuperCore
*
- * @ingroup RTEMSInternal
+ * @ingroup RTEMSImpl
*
* @brief Provides services for all APIs.
*
--
2.26.2
More information about the devel
mailing list