[rtems commit] doxygen: Rename Internal to Implementation

Sebastian Huber sebh at rtems.org
Mon Nov 23 09:42:22 UTC 2020 

Module:    rtems
Branch:    master
Commit:    f1d932d510bcd818249257800e1e5429cf1f322e
Changeset: http://git.rtems.org/rtems/commit/?id=f1d932d510bcd818249257800e1e5429cf1f322e

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Tue Oct 13 14:35:18 2020 +0200

doxygen: Rename Internal to Implementation

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 c159b20..0428424 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 c1a91a3..2916ec0 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 b53ed0b..fb4a7b9 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 12d0bb6..ed9da1f 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 1300b5f..f4be4cf 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 561a563..fc669af 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 90910ca..e940cbb 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 071fbcc..feb4f18 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 fce66b8..fbb4dea 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 f848700..ce98b3c 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 1b4ad41..21a4884 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 c90ac97..a3a3842 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 c151971..e41c4bc 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 08a9749..11b6df9 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 e841ec2..4d5a877 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 ec26e54..b2bbd90 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 89fd288..5e51afd 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 da94a9b..e9213ce 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 0cb78e3..3cf7b9c 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 6766868..5945398 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 77fe20c..77a081b 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 a0aa252..5eb412c 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 9748792..4dd7951 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 6c39af6..ffc8962 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.
  *

More information about the vc mailing list