[rtems commit] doxygen: Restructured cpukit/include/rtems/rtems

Sebastian Huber sebh at rtems.org
Tue Apr 2 05:31:47 UTC 2019


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

Author:    Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date:      Thu Mar 28 13:27:05 2019 +0100

doxygen: Restructured cpukit/include/rtems/rtems

Update #3706.

---

 cpukit/doxygen.h                         | 14 ++++++++++++++
 cpukit/include/rtems.h                   | 16 ++++++++--------
 cpukit/include/rtems/chain.h             |  2 +-
 cpukit/include/rtems/counter.h           |  2 +-
 cpukit/include/rtems/extension.h         |  2 +-
 cpukit/include/rtems/fatal.h             |  2 +-
 cpukit/include/rtems/io.h                |  2 +-
 cpukit/include/rtems/rbheap.h            |  2 +-
 cpukit/include/rtems/rbtree.h            |  2 +-
 cpukit/include/rtems/rtems/asr.h         |  4 ++--
 cpukit/include/rtems/rtems/asrimpl.h     |  2 +-
 cpukit/include/rtems/rtems/attr.h        |  4 ++--
 cpukit/include/rtems/rtems/attrimpl.h    |  2 +-
 cpukit/include/rtems/rtems/barrier.h     |  2 +-
 cpukit/include/rtems/rtems/barrierimpl.h |  2 +-
 cpukit/include/rtems/rtems/cache.h       |  2 +-
 cpukit/include/rtems/rtems/clock.h       |  4 ++--
 cpukit/include/rtems/rtems/config.h      |  4 ++--
 cpukit/include/rtems/rtems/dpmem.h       |  2 +-
 cpukit/include/rtems/rtems/dpmemimpl.h   |  2 +-
 cpukit/include/rtems/rtems/event.h       |  2 +-
 cpukit/include/rtems/rtems/eventimpl.h   |  2 +-
 cpukit/include/rtems/rtems/eventmp.h     |  2 +-
 cpukit/include/rtems/rtems/intr.h        |  4 ++--
 cpukit/include/rtems/rtems/mainpage.h    |  2 +-
 cpukit/include/rtems/rtems/message.h     |  2 +-
 cpukit/include/rtems/rtems/messageimpl.h |  2 +-
 cpukit/include/rtems/rtems/modes.h       |  4 ++--
 cpukit/include/rtems/rtems/modesimpl.h   |  2 +-
 cpukit/include/rtems/rtems/mp.h          |  4 ++--
 cpukit/include/rtems/rtems/object.h      |  4 ++--
 cpukit/include/rtems/rtems/options.h     |  4 ++--
 cpukit/include/rtems/rtems/optionsimpl.h |  2 +-
 cpukit/include/rtems/rtems/part.h        |  2 +-
 cpukit/include/rtems/rtems/partimpl.h    |  2 +-
 cpukit/include/rtems/rtems/ratemon.h     |  4 ++--
 cpukit/include/rtems/rtems/ratemonimpl.h |  2 +-
 cpukit/include/rtems/rtems/region.h      |  2 +-
 cpukit/include/rtems/rtems/regionimpl.h  |  2 +-
 cpukit/include/rtems/rtems/sem.h         |  2 +-
 cpukit/include/rtems/rtems/semimpl.h     |  2 +-
 cpukit/include/rtems/rtems/semmp.h       |  2 +-
 cpukit/include/rtems/rtems/signal.h      |  2 +-
 cpukit/include/rtems/rtems/signalimpl.h  |  2 +-
 cpukit/include/rtems/rtems/smp.h         |  2 +-
 cpukit/include/rtems/rtems/status.h      |  4 ++--
 cpukit/include/rtems/rtems/statusimpl.h  |  2 +-
 cpukit/include/rtems/rtems/support.h     |  6 +++---
 cpukit/include/rtems/rtems/taskmp.h      |  2 +-
 cpukit/include/rtems/rtems/tasks.h       |  2 +-
 cpukit/include/rtems/rtems/tasksimpl.h   |  2 +-
 cpukit/include/rtems/rtems/timer.h       |  2 +-
 cpukit/include/rtems/rtems/timerimpl.h   |  2 +-
 cpukit/include/rtems/rtems/types.h       |  5 +++--
 cpukit/include/rtems/timespec.h          |  2 +-
 55 files changed, 90 insertions(+), 75 deletions(-)

diff --git a/cpukit/doxygen.h b/cpukit/doxygen.h
index 449026b..34a8406 100644
--- a/cpukit/doxygen.h
+++ b/cpukit/doxygen.h
@@ -3,3 +3,17 @@
  *
  * @brief RTEMS Implementation.
  */
+
+/**
+ * @defgroup RTEMSInternalClassic Classic
+ * 
+ * @ingroup RTEMSInternal
+ *
+ * @brief Classic
+ */
+
+/**
+ * @defgroup RTEMSAPI API
+ *
+ * @brief API
+ */
diff --git a/cpukit/include/rtems.h b/cpukit/include/rtems.h
index 8c70734..20a1705 100644
--- a/cpukit/include/rtems.h
+++ b/cpukit/include/rtems.h
@@ -1,9 +1,7 @@
 /**
  * @file
- *
- * @defgroup ClassicRTEMS RTEMS Classic API
- *
- * @brief RTEMS Classic API
+ * 
+ * @ingroup RTEMSAPIClassic
  *
  * the Public Interface to the RTEMS Classic API
  */
@@ -20,11 +18,13 @@
 #define _RTEMS_H
 
 /**
- * @defgroup ClassicRTEMS RTEMS Classic API
+ * @defgroup RTEMSAPIClassic Classic
  *
- * RTEMS Classic API definitions and modules.
+ * @ingroup RTEMSAPI
+ * 
+ * @brief RTEMS Classic API definitions and modules.
  */
-/**@{*/
+/** @{ */
 
 #include <rtems/system.h>
 #include <rtems/rtems/status.h>
@@ -187,7 +187,7 @@ const char *rtems_get_version_string(void);
 }
 #endif
 
-/**@}*/
+/** @} */
 
 #endif
 /* end of include file */
diff --git a/cpukit/include/rtems/chain.h b/cpukit/include/rtems/chain.h
index f0e7ee4..11ebdca 100644
--- a/cpukit/include/rtems/chain.h
+++ b/cpukit/include/rtems/chain.h
@@ -28,7 +28,7 @@ extern "C" {
 /**
  * @defgroup ClassicChains Chains
  *
- * @ingroup ClassicRTEMS
+ * @ingroup RTEMSAPIClassic
  *
  * @brief Chain API
  */
diff --git a/cpukit/include/rtems/counter.h b/cpukit/include/rtems/counter.h
index f43b7f1..caf0491 100644
--- a/cpukit/include/rtems/counter.h
+++ b/cpukit/include/rtems/counter.h
@@ -32,7 +32,7 @@ extern "C" {
 /**
  * @defgroup ClassicCounter Free-Running Counter and Busy Wait Delay
  *
- * @ingroup ClassicRTEMS
+ * @ingroup RTEMSAPIClassic
  *
  * @brief Free-running counter and busy wait delay functions.
  *
diff --git a/cpukit/include/rtems/extension.h b/cpukit/include/rtems/extension.h
index da219ac..ec9ad7f 100644
--- a/cpukit/include/rtems/extension.h
+++ b/cpukit/include/rtems/extension.h
@@ -32,7 +32,7 @@ typedef User_extensions_routine
 /**
  * @defgroup ClassicUserExtensions User Extensions
  *
- * @ingroup ClassicRTEMS
+ * @ingroup RTEMSAPIClassic
  *
  * @brief The User Extensions Manager allows the application developer to
  * augment the executive by allowing them to supply extension routines which
diff --git a/cpukit/include/rtems/fatal.h b/cpukit/include/rtems/fatal.h
index 291af42..3fc6a89 100644
--- a/cpukit/include/rtems/fatal.h
+++ b/cpukit/include/rtems/fatal.h
@@ -26,7 +26,7 @@ extern "C" {
 /**
  * @defgroup ClassicFatal Fatal
  *
- * @ingroup ClassicRTEMS
+ * @ingroup RTEMSAPIClassic
  *
  * @brief The Fatal Manager provides functions for fatal system states and or
  * irrecoverable errors.
diff --git a/cpukit/include/rtems/io.h b/cpukit/include/rtems/io.h
index 760d412..972a0aa 100644
--- a/cpukit/include/rtems/io.h
+++ b/cpukit/include/rtems/io.h
@@ -28,7 +28,7 @@ extern "C" {
 /**
  * @defgroup ClassicIO Input/Output
  *
- * @ingroup ClassicRTEMS
+ * @ingroup RTEMSAPIClassic
  *
  */
 /**@{**/
diff --git a/cpukit/include/rtems/rbheap.h b/cpukit/include/rtems/rbheap.h
index 735aa6c..d772c1a 100644
--- a/cpukit/include/rtems/rbheap.h
+++ b/cpukit/include/rtems/rbheap.h
@@ -32,7 +32,7 @@ extern "C" {
 /**
  * @defgroup RBHeap Red-Black Tree Heap
  *
- * @ingroup ClassicRTEMS
+ * @ingroup RTEMSAPIClassic
  *
  * @brief Red-Black Tree Heap API.
  *
diff --git a/cpukit/include/rtems/rbtree.h b/cpukit/include/rtems/rbtree.h
index 57821cf..6a45037 100644
--- a/cpukit/include/rtems/rbtree.h
+++ b/cpukit/include/rtems/rbtree.h
@@ -29,7 +29,7 @@ extern "C" {
 /**
  * @defgroup ClassicRBTrees Red-Black Trees
  *
- * @ingroup ClassicRTEMS
+ * @ingroup RTEMSAPIClassic
  *
  * @brief A Red-Black Tree container.
  *
diff --git a/cpukit/include/rtems/rtems/asr.h b/cpukit/include/rtems/rtems/asr.h
index 8529d3b..c157719 100644
--- a/cpukit/include/rtems/rtems/asr.h
+++ b/cpukit/include/rtems/rtems/asr.h
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @addtogroup ClassicASR
+ * @ingroup ClassicASR
  *
  * This include file contains all the constants and structures associated
  * with the Asynchronous Signal Handler. This Handler provides the low-level
@@ -28,7 +28,7 @@ extern "C" {
 /**
  *  @defgroup ClassicASR ASR Support
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  This encapsulates functionality related to the Classic API Signal
  *  Manager.
diff --git a/cpukit/include/rtems/rtems/asrimpl.h b/cpukit/include/rtems/rtems/asrimpl.h
index 38cc1e2..8e8efe5 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 ClassicASR
+ * @ingroup RTEMSInternalClassic
  *
  * @{
  */
diff --git a/cpukit/include/rtems/rtems/attr.h b/cpukit/include/rtems/rtems/attr.h
index d58b6f8..abc9da0 100644
--- a/cpukit/include/rtems/rtems/attr.h
+++ b/cpukit/include/rtems/rtems/attr.h
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @addtogroup ClassicAttributes
+ * @ingroup ClassicAttributes
  *
  * This include file contains all information about the Object Attributes
  * Handler.
@@ -27,7 +27,7 @@ extern "C" {
 /**
  *  @defgroup ClassicAttributes Attributes
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  This encapsulates functionality which defines and manages the
  *  set of Classic API object attributes.
diff --git a/cpukit/include/rtems/rtems/attrimpl.h b/cpukit/include/rtems/rtems/attrimpl.h
index bb8e5f8..071fbcc 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 ClassicAttributes
+ * @ingroup RTEMSInternalClassic
  *
  * @{
  */
diff --git a/cpukit/include/rtems/rtems/barrier.h b/cpukit/include/rtems/rtems/barrier.h
index 7422f78..f6362f9 100644
--- a/cpukit/include/rtems/rtems/barrier.h
+++ b/cpukit/include/rtems/rtems/barrier.h
@@ -28,7 +28,7 @@ extern "C" {
 /**
  * @defgroup ClassicBarrier Barriers
  *
- * @ingroup ClassicRTEMS
+ * @ingroup RTEMSAPIClassic
  *
  * This encapsulates functionality which implements the Classic API
  * Barrier Manager.
diff --git a/cpukit/include/rtems/rtems/barrierimpl.h b/cpukit/include/rtems/rtems/barrierimpl.h
index 5494191..fce66b8 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 ClassicBarrier
+ *  @ingroup RTEMSInternalClassic
  *
  *  @{
  */
diff --git a/cpukit/include/rtems/rtems/cache.h b/cpukit/include/rtems/rtems/cache.h
index 1e62c42..dfcb8f6 100644
--- a/cpukit/include/rtems/rtems/cache.h
+++ b/cpukit/include/rtems/rtems/cache.h
@@ -28,7 +28,7 @@ extern "C" {
 /**
  * @defgroup ClassicCache Cache
  *
- * @ingroup ClassicRTEMS
+ * @ingroup RTEMSAPIClassic
  *
  * @brief The Cache Manager provides functions to perform maintenance
  * operations for data and instruction caches.
diff --git a/cpukit/include/rtems/rtems/clock.h b/cpukit/include/rtems/rtems/clock.h
index 558c612..7f2887f 100644
--- a/cpukit/include/rtems/rtems/clock.h
+++ b/cpukit/include/rtems/rtems/clock.h
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @addtogroup ClassicClock
+ * @ingroup ClassicClock
  *
  * This include file contains all the constants and structures associated
  * with the Clock Manager. This manager provides facilities to set, obtain,
@@ -33,7 +33,7 @@
 /**
  *  @defgroup ClassicClock Clocks
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  This encapsulates functionality related to the Classic API Clock
  *  Manager.
diff --git a/cpukit/include/rtems/rtems/config.h b/cpukit/include/rtems/rtems/config.h
index b9c920d..63449be 100644
--- a/cpukit/include/rtems/rtems/config.h
+++ b/cpukit/include/rtems/rtems/config.h
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @addtogroup ClassicConfig
+ * @ingroup ClassicConfig
  *
  * This include file contains the table of user defined configuration
  * parameters specific for the RTEMS API.
@@ -28,7 +28,7 @@ extern "C" {
 /**
  *  @defgroup ClassicConfig Configuration
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  This encapsulates functionality related to the application's configuration
  *  of the Classic API including the maximum number of each class of objects.
diff --git a/cpukit/include/rtems/rtems/dpmem.h b/cpukit/include/rtems/rtems/dpmem.h
index d3a33ad..edd0809 100644
--- a/cpukit/include/rtems/rtems/dpmem.h
+++ b/cpukit/include/rtems/rtems/dpmem.h
@@ -27,7 +27,7 @@ extern "C" {
 /**
  *  @defgroup ClassicDPMEM Dual Ported Memory
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  This encapsulates functionality related to the
  *  Classic API Dual Ported Memory Manager.
diff --git a/cpukit/include/rtems/rtems/dpmemimpl.h b/cpukit/include/rtems/rtems/dpmemimpl.h
index 3da0d52..f848700 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 ClassicDPMEM
+ * @ingroup RTEMSInternalClassic
  *
  * @{
  */
diff --git a/cpukit/include/rtems/rtems/event.h b/cpukit/include/rtems/rtems/event.h
index f37060a..48a871e 100644
--- a/cpukit/include/rtems/rtems/event.h
+++ b/cpukit/include/rtems/rtems/event.h
@@ -114,7 +114,7 @@ typedef uint32_t   rtems_event_set;
 /**
  *  @defgroup ClassicEvent Events
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  @brief The event manager provides a high performance method of intertask
  *  communication and synchronization.
diff --git a/cpukit/include/rtems/rtems/eventimpl.h b/cpukit/include/rtems/rtems/eventimpl.h
index ae249ee..1b4ad41 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 ClassicEvent
+ * @ingroup RTEMSInternalClassic
  *
  * @{
  */
diff --git a/cpukit/include/rtems/rtems/eventmp.h b/cpukit/include/rtems/rtems/eventmp.h
index d3df103..f9fb1e9 100644
--- a/cpukit/include/rtems/rtems/eventmp.h
+++ b/cpukit/include/rtems/rtems/eventmp.h
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @addtogroup ClassicEventMP
+ * @ingroup ClassicEventMP
  *
  * This include file contains all the constants and structures associated
  * with the Multiprocessing Support in the Event Manager.
diff --git a/cpukit/include/rtems/rtems/intr.h b/cpukit/include/rtems/rtems/intr.h
index fb29d0d..a55b64d2 100644
--- a/cpukit/include/rtems/rtems/intr.h
+++ b/cpukit/include/rtems/rtems/intr.h
@@ -1,7 +1,7 @@
 /**
  *  @file
  *
- * @addtogroup ClassicINTR
+ * @ingroup ClassicINTR
  *
  * This include file contains all the constants and structures associated with
  * the Interrupt Manager.
@@ -29,7 +29,7 @@ extern "C" {
 /**
  *  @defgroup ClassicINTR Interrupts
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  This encapsulates functionality related to the Classic API Interrupt
  *  Manager.
diff --git a/cpukit/include/rtems/rtems/mainpage.h b/cpukit/include/rtems/rtems/mainpage.h
index b2277e9..ab9e442 100644
--- a/cpukit/include/rtems/rtems/mainpage.h
+++ b/cpukit/include/rtems/rtems/mainpage.h
@@ -923,7 +923,7 @@
  /**
   * @defgroup LocalPackages Local Packages
   * 
-  * @ingroup ClassicRTEMS
+  * @ingroup RTEMSAPIClassic
   *
   * @brief Local packages.
   */
diff --git a/cpukit/include/rtems/rtems/message.h b/cpukit/include/rtems/rtems/message.h
index 768b0ba..d224c95 100644
--- a/cpukit/include/rtems/rtems/message.h
+++ b/cpukit/include/rtems/rtems/message.h
@@ -29,7 +29,7 @@ extern "C" {
 /**
  *  @defgroup ClassicMessageQueue Message Queues
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  This encapsulates functionality related to the Classic API Message Queue
  *  Manager.
diff --git a/cpukit/include/rtems/rtems/messageimpl.h b/cpukit/include/rtems/rtems/messageimpl.h
index 5872b67..e317244 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 ClassicMessageQueue
+ *  @ingroup RTEMSInternalClassic
  *
  *  @{
  */
diff --git a/cpukit/include/rtems/rtems/modes.h b/cpukit/include/rtems/rtems/modes.h
index 39167c0..ccaef24 100644
--- a/cpukit/include/rtems/rtems/modes.h
+++ b/cpukit/include/rtems/rtems/modes.h
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @addtogroup ClassicModes
+ * @ingroup ClassicModes
  *
  * This include file contains all constants and structures associated
  * with the RTEMS thread and RTEMS_ASR modes.
@@ -27,7 +27,7 @@ extern "C" {
 /**
  *  @defgroup ClassicModes Modes
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  This encapsulates functionality related to the task modes supported
  *  by the Classic API Task Manager.
diff --git a/cpukit/include/rtems/rtems/modesimpl.h b/cpukit/include/rtems/rtems/modesimpl.h
index 318cc36..c151971 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 ClassicModes
+ * @ingroup RTEMSInternalClassic
  *
  * @{
  */
diff --git a/cpukit/include/rtems/rtems/mp.h b/cpukit/include/rtems/rtems/mp.h
index 842d430..a3de1e6 100644
--- a/cpukit/include/rtems/rtems/mp.h
+++ b/cpukit/include/rtems/rtems/mp.h
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @addtogroup ClassicMP
+ * @ingroup ClassicMP
  *
  * This include file contains all the constants and structures associated
  * with the Multiprocessing Manager.
@@ -21,7 +21,7 @@
 /**
  *  @defgroup ClassicMP Multiprocessing
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  This encapsulates functionality related to the distributed
  *  Multiprocessing support in the Classic API.
diff --git a/cpukit/include/rtems/rtems/object.h b/cpukit/include/rtems/rtems/object.h
index a685512..3f70fc3 100644
--- a/cpukit/include/rtems/rtems/object.h
+++ b/cpukit/include/rtems/rtems/object.h
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @addtogroup ClassicClassInfo
+ * @ingroup ClassicClassInfo
  *
  * This include file defines Classic API interfaces to Object Services.
  */
@@ -29,7 +29,7 @@ extern "C" {
 /**
  *  @defgroup ClassicClassInfo Object Class Information
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  This encapsulates functionality related to the Classic API Object
  *  Class Services.
diff --git a/cpukit/include/rtems/rtems/options.h b/cpukit/include/rtems/rtems/options.h
index a2d0e6d..e50c4d1 100644
--- a/cpukit/include/rtems/rtems/options.h
+++ b/cpukit/include/rtems/rtems/options.h
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @addtogroup ClassicOptions
+ * @ingroup ClassicOptions
  *
  * This include file contains information which defines the
  * options available on many directives.
@@ -27,7 +27,7 @@ extern "C" {
 /**
  * @defgroup ClassicOptions Classic API Options
  *
- * @ingroup ClassicRTEMS
+ * @ingroup RTEMSAPIClassic
  *
  * This encapsulates functionality related to the options argument
  * to Classic API blocking operations. The primary option is whether
diff --git a/cpukit/include/rtems/rtems/optionsimpl.h b/cpukit/include/rtems/rtems/optionsimpl.h
index 0263fcf..e841ec2 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 ClassicOptions
+ * @ingroup RTEMSInternalClassic
  *
  * @{
  */
diff --git a/cpukit/include/rtems/rtems/part.h b/cpukit/include/rtems/rtems/part.h
index 7208f88..5a64843 100644
--- a/cpukit/include/rtems/rtems/part.h
+++ b/cpukit/include/rtems/rtems/part.h
@@ -28,7 +28,7 @@ extern "C" {
 /**
  *  @defgroup ClassicPart Partitions
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  This encapsulates functionality related to the
  *  Classic API Partition Manager.
diff --git a/cpukit/include/rtems/rtems/partimpl.h b/cpukit/include/rtems/rtems/partimpl.h
index 28b8b50..ec26e54 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 ClassicPart
+ * @ingroup RTEMSInternalClassic
  *
  * @{
  */
diff --git a/cpukit/include/rtems/rtems/ratemon.h b/cpukit/include/rtems/rtems/ratemon.h
index 062602c..c591837 100644
--- a/cpukit/include/rtems/rtems/ratemon.h
+++ b/cpukit/include/rtems/rtems/ratemon.h
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @addtogroup ClassicRateMon
+ * @ingroup ClassicRateMon
  *
  * This include file contains all the constants, structures, and
  * prototypes associated with the Rate Monotonic Manager. This manager
@@ -42,7 +42,7 @@ extern "C" {
 /**
  *  @defgroup ClassicRateMon Rate Monotonic Scheduler
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  This encapsulates functionality related to the Classic API Rate
  *  Monotonic Manager.
diff --git a/cpukit/include/rtems/rtems/ratemonimpl.h b/cpukit/include/rtems/rtems/ratemonimpl.h
index eb359b1..89fd288 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 ClassicRateMon
+ * @ingroup RTEMSInternalClassic
  *
  * @{
  */
diff --git a/cpukit/include/rtems/rtems/region.h b/cpukit/include/rtems/rtems/region.h
index baa8a72..0809a31 100644
--- a/cpukit/include/rtems/rtems/region.h
+++ b/cpukit/include/rtems/rtems/region.h
@@ -29,7 +29,7 @@ extern "C" {
 /**
  *  @defgroup ClassicRegion Regions
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  This encapsulates functionality related to the Classic API Region
  *  Manager.
diff --git a/cpukit/include/rtems/rtems/regionimpl.h b/cpukit/include/rtems/rtems/regionimpl.h
index 3577567..da94a9b 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 ClassicRegion
+ * @ingroup RTEMSInternalClassic
  *
  * @{
  */
diff --git a/cpukit/include/rtems/rtems/sem.h b/cpukit/include/rtems/rtems/sem.h
index 8e83848..3dcdfbf 100644
--- a/cpukit/include/rtems/rtems/sem.h
+++ b/cpukit/include/rtems/rtems/sem.h
@@ -30,7 +30,7 @@ extern "C" {
 /**
  *  @defgroup ClassicSem Semaphores
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  This encapsulates functionality related to the Classic API
  *  Semaphore Manager.
diff --git a/cpukit/include/rtems/rtems/semimpl.h b/cpukit/include/rtems/rtems/semimpl.h
index 743a4a9..dd6a8b4 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 ClassicSem
+ * @ingroup RTEMSInternalClassic
  *
  * @{
  */
diff --git a/cpukit/include/rtems/rtems/semmp.h b/cpukit/include/rtems/rtems/semmp.h
index a3bfb5e..4a3dbe6 100644
--- a/cpukit/include/rtems/rtems/semmp.h
+++ b/cpukit/include/rtems/rtems/semmp.h
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @addtogroup ClassicSEM
+ * @ingroup ClassicSEM
  *
  * This include file contains all the constants and structures associated
  * with the Multiprocessing Support in the Semaphore Manager.
diff --git a/cpukit/include/rtems/rtems/signal.h b/cpukit/include/rtems/rtems/signal.h
index f7b7000..1ed1392 100644
--- a/cpukit/include/rtems/rtems/signal.h
+++ b/cpukit/include/rtems/rtems/signal.h
@@ -29,7 +29,7 @@ extern "C" {
 /**
  * @defgroup ClassicSignal Signals
  *
- * @ingroup ClassicRTEMS
+ * @ingroup RTEMSAPIClassic
  *
  * Directives provided are:
  *
diff --git a/cpukit/include/rtems/rtems/signalimpl.h b/cpukit/include/rtems/rtems/signalimpl.h
index 61848ae..6766868 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 ClassicSignal
+ * @ingroup RTEMSInternalClassic
  */
 /**@{*/
 
diff --git a/cpukit/include/rtems/rtems/smp.h b/cpukit/include/rtems/rtems/smp.h
index aeb0df6..2e0fd67 100644
--- a/cpukit/include/rtems/rtems/smp.h
+++ b/cpukit/include/rtems/rtems/smp.h
@@ -27,7 +27,7 @@ extern "C" {
 /**
  * @defgroup ClassicSMP SMP Services
  *
- * @ingroup ClassicRTEMS
+ * @ingroup RTEMSAPIClassic
  *
  * This encapsulates functionality which is useful for SMP applications.
  *
diff --git a/cpukit/include/rtems/rtems/status.h b/cpukit/include/rtems/rtems/status.h
index c4175dc..88ae576 100644
--- a/cpukit/include/rtems/rtems/status.h
+++ b/cpukit/include/rtems/rtems/status.h
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @addtogroup ClassicStatus
+ * @ingroup ClassicStatus
  *
  * This include file contains the status codes returned from the
  * executive directives.
@@ -27,7 +27,7 @@ extern "C" {
 /**
  *  @defgroup ClassicStatus Status Codes
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  This encapsulates functionality related to the status codes returned
  *  by Classic API directives.
diff --git a/cpukit/include/rtems/rtems/statusimpl.h b/cpukit/include/rtems/rtems/statusimpl.h
index 8a51bb8..77fe20c 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 ClassicStatus
+ * @ingroup RTEMSInternalClassic
  *
  * @{
  */
diff --git a/cpukit/include/rtems/rtems/support.h b/cpukit/include/rtems/rtems/support.h
index 5834dba..944e9fb 100644
--- a/cpukit/include/rtems/rtems/support.h
+++ b/cpukit/include/rtems/rtems/support.h
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @addtogroup ClassicRTEMSWorkspace
+ * @ingroup ClassicRTEMSWorkspace
  */
 
 /* COPYRIGHT (c) 1989-2008.
@@ -23,7 +23,7 @@ extern "C" {
 #endif
 
 /**
- * @addtogroup ClassicRTEMS
+ * @addtogroup ClassicTasks
  */
 /**@{**/
 
@@ -78,7 +78,7 @@ RTEMS_INLINE_ROUTINE void rtems_name_to_characters(
 /**
  * @defgroup ClassicRTEMSWorkspace Workspace
  *
- * @ingroup ClassicRTEMS
+ * @ingroup RTEMSAPIClassic
  *
  * Workspace definitions.
  */
diff --git a/cpukit/include/rtems/rtems/taskmp.h b/cpukit/include/rtems/rtems/taskmp.h
index 346b24f..8acfb0d 100644
--- a/cpukit/include/rtems/rtems/taskmp.h
+++ b/cpukit/include/rtems/rtems/taskmp.h
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @addtogroup ClassicTaskMP
+ * @ingroup ClassicTaskMP
  *
  * This include file contains all the constants and structures associated
  * with the multiprocessing support in the task manager.
diff --git a/cpukit/include/rtems/rtems/tasks.h b/cpukit/include/rtems/rtems/tasks.h
index aa1f5a4..4a04e71 100644
--- a/cpukit/include/rtems/rtems/tasks.h
+++ b/cpukit/include/rtems/rtems/tasks.h
@@ -29,7 +29,7 @@ extern "C" {
 /**
  *  @defgroup ClassicTasks Tasks
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  This encapsulates the functionality of the Classic API Task Manager.
  *  This functionality includes task services such as creation, deletion,
diff --git a/cpukit/include/rtems/rtems/tasksimpl.h b/cpukit/include/rtems/rtems/tasksimpl.h
index c98f1a3..c9544f8 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 ClassicTasks
+ * @ingroup RTEMSInternalClassic
  *
  * @{
  */
diff --git a/cpukit/include/rtems/rtems/timer.h b/cpukit/include/rtems/rtems/timer.h
index cc21b2b..244d560 100644
--- a/cpukit/include/rtems/rtems/timer.h
+++ b/cpukit/include/rtems/rtems/timer.h
@@ -32,7 +32,7 @@ extern "C" {
 /**
  *  @defgroup ClassicTimer Timers
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  This encapsulates functionality related to the Classic API Timer
  *  Manager.  This manager provides functionality which allows the
diff --git a/cpukit/include/rtems/rtems/timerimpl.h b/cpukit/include/rtems/rtems/timerimpl.h
index 59b2b9f..9748792 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 ClassicTimer
+ * @ingroup RTEMSInternalClassic
  *
  * @{
  */
diff --git a/cpukit/include/rtems/rtems/types.h b/cpukit/include/rtems/rtems/types.h
index 0eae24b..47c3b4c 100644
--- a/cpukit/include/rtems/rtems/types.h
+++ b/cpukit/include/rtems/rtems/types.h
@@ -3,7 +3,8 @@
  *
  * @defgroup ClassicTypes Types
  *
- * @ingroup ClassicRTEMS
+ * @ingroup RTEMSAPIClassic
+ * 
  * @brief Types used by Classic API.
  */
 
@@ -39,7 +40,7 @@ extern "C" {
 #endif
 
 /**
- * @addtogroup ClassicRTEMS
+ * @addtogroup ClassicTasks
  */
 /**@{**/
 
diff --git a/cpukit/include/rtems/timespec.h b/cpukit/include/rtems/timespec.h
index e82d271..1e9eea7 100644
--- a/cpukit/include/rtems/timespec.h
+++ b/cpukit/include/rtems/timespec.h
@@ -27,7 +27,7 @@ extern "C" {
 /**
  *  @defgroup TimespecAPI Timespec
  *
- *  @ingroup ClassicRTEMS
+ *  @ingroup RTEMSAPIClassic
  *
  *  @brief Timespec API
  * 



More information about the vc mailing list