[PATCH 19/25] Reviewed @defgroup in cpukit/include/rtems/rtems

Sebastian Huber sebastian.huber at embedded-brains.de
Fri Mar 29 10:53:04 UTC 2019 

From: Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>

Update #3706.
---
 cpukit/include/rtems/rtems/asr.h      | 5 +----
 cpukit/include/rtems/rtems/attr.h     | 5 +----
 cpukit/include/rtems/rtems/clock.h    | 5 +----
 cpukit/include/rtems/rtems/config.h   | 5 +----
 cpukit/include/rtems/rtems/eventmp.h  | 5 +----
 cpukit/include/rtems/rtems/intr.h     | 5 +----
 cpukit/include/rtems/rtems/mainpage.h | 2 ++
 cpukit/include/rtems/rtems/modes.h    | 5 +----
 cpukit/include/rtems/rtems/mp.h       | 5 +----
 cpukit/include/rtems/rtems/object.h   | 5 +----
 cpukit/include/rtems/rtems/options.h  | 5 +----
 cpukit/include/rtems/rtems/ratemon.h  | 5 +----
 cpukit/include/rtems/rtems/semmp.h    | 5 +----
 cpukit/include/rtems/rtems/status.h   | 5 +----
 cpukit/include/rtems/rtems/support.h  | 5 +----
 cpukit/include/rtems/rtems/taskmp.h   | 5 +----
 16 files changed, 17 insertions(+), 60 deletions(-)

diff --git a/cpukit/include/rtems/rtems/asr.h b/cpukit/include/rtems/rtems/asr.h
index 9bc6b433bb..8529d3b30f 100644
--- a/cpukit/include/rtems/rtems/asr.h
+++ b/cpukit/include/rtems/rtems/asr.h
@@ -1,10 +1,7 @@
 /**
  * @file
  *
- * @defgroup ClassicASR ASR Support
- *
- * @ingroup ClassicRTEMS
- * @brief Asynchronous Signal Handler
+ * @addtogroup ClassicASR
  *
  * This include file contains all the constants and structures associated
  * with the Asynchronous Signal Handler. This Handler provides the low-level
diff --git a/cpukit/include/rtems/rtems/attr.h b/cpukit/include/rtems/rtems/attr.h
index 758d41df1e..d58b6f8033 100644
--- a/cpukit/include/rtems/rtems/attr.h
+++ b/cpukit/include/rtems/rtems/attr.h
@@ -1,10 +1,7 @@
 /**
  * @file
  *
- * @defgroup ClassicAttributes Attributes
- *
- * @ingroup ClassicRTEMS
- * @brief Object Attributes Handler
+ * @addtogroup ClassicAttributes
  *
  * This include file contains all information about the Object Attributes
  * Handler.
diff --git a/cpukit/include/rtems/rtems/clock.h b/cpukit/include/rtems/rtems/clock.h
index d08d2cd1b4..558c612d4b 100644
--- a/cpukit/include/rtems/rtems/clock.h
+++ b/cpukit/include/rtems/rtems/clock.h
@@ -1,10 +1,7 @@
 /**
  * @file
  *
- * @defgroup ClassicClock Clocks
- *
- * @ingroup ClassicRTEMS
- * @brief Clock Manager API
+ * @addtogroup ClassicClock
  *
  * This include file contains all the constants and structures associated
  * with the Clock Manager. This manager provides facilities to set, obtain,
diff --git a/cpukit/include/rtems/rtems/config.h b/cpukit/include/rtems/rtems/config.h
index ad1dcb6dbd..b9c920dfeb 100644
--- a/cpukit/include/rtems/rtems/config.h
+++ b/cpukit/include/rtems/rtems/config.h
@@ -1,10 +1,7 @@
 /**
  * @file
  *
- * @defgroup ClassicConfig Configuration
- *
- * @ingroup ClassicRTEMS
- * @brief Configuration Table
+ * @addtogroup ClassicConfig
  *
  * This include file contains the table of user defined configuration
  * parameters specific for the RTEMS API.
diff --git a/cpukit/include/rtems/rtems/eventmp.h b/cpukit/include/rtems/rtems/eventmp.h
index 5f5f2248c4..d3df103a8c 100644
--- a/cpukit/include/rtems/rtems/eventmp.h
+++ b/cpukit/include/rtems/rtems/eventmp.h
@@ -1,10 +1,7 @@
 /**
  * @file
  *
- * @defgroup ClassicEventMP Event MP Support
- *
- * @ingroup ClassicRTEMS
- * @brief Event Manager MP Support
+ * @addtogroup 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 be216a013c..fb29d0d6cc 100644
--- a/cpukit/include/rtems/rtems/intr.h
+++ b/cpukit/include/rtems/rtems/intr.h
@@ -1,10 +1,7 @@
 /**
  *  @file
  *
- * @defgroup ClassicINTR Interrupts
- *
- * @ingroup ClassicRTEMS
- * @brief Header file for Interrupt Manager
+ * @addtogroup ClassicINTR
  *
  * This include file contains all the constants and structures associated with
  * the Interrupt Manager.
diff --git a/cpukit/include/rtems/rtems/mainpage.h b/cpukit/include/rtems/rtems/mainpage.h
index eb8faba925..b2277e99f3 100644
--- a/cpukit/include/rtems/rtems/mainpage.h
+++ b/cpukit/include/rtems/rtems/mainpage.h
@@ -922,6 +922,8 @@
 
  /**
   * @defgroup LocalPackages Local Packages
+  * 
+  * @ingroup ClassicRTEMS
   *
   * @brief Local packages.
   */
diff --git a/cpukit/include/rtems/rtems/modes.h b/cpukit/include/rtems/rtems/modes.h
index 6afb0c9def..39167c043f 100644
--- a/cpukit/include/rtems/rtems/modes.h
+++ b/cpukit/include/rtems/rtems/modes.h
@@ -1,10 +1,7 @@
 /**
  * @file
  *
- * @defgroup ClassicModes Modes
- *
- * @ingroup ClassicRTEMS
- * @brief RTEMS thread and RTEMS_ASR modes
+ * @addtogroup ClassicModes
  *
  * This include file contains all constants and structures associated
  * with the RTEMS thread and RTEMS_ASR modes.
diff --git a/cpukit/include/rtems/rtems/mp.h b/cpukit/include/rtems/rtems/mp.h
index 7a8a1ea5ec..842d4305f0 100644
--- a/cpukit/include/rtems/rtems/mp.h
+++ b/cpukit/include/rtems/rtems/mp.h
@@ -1,10 +1,7 @@
 /**
  * @file
  *
- * @defgroup ClassicMP Multiprocessing
- *
- * @ingroup ClassicRTEMS
- * @brief Multiprocessing Manager
+ * @addtogroup ClassicMP
  *
  * This include file contains all the constants and structures associated
  * with the Multiprocessing Manager.
diff --git a/cpukit/include/rtems/rtems/object.h b/cpukit/include/rtems/rtems/object.h
index ea64f1d062..a685512b23 100644
--- a/cpukit/include/rtems/rtems/object.h
+++ b/cpukit/include/rtems/rtems/object.h
@@ -1,10 +1,7 @@
 /**
  * @file
  *
- * @defgroup ClassicClassInfo Object Class Information
- *
- * @ingroup ClassicRTEMS
- * @brief Classic API interfaces to Object Services
+ * @addtogroup ClassicClassInfo
  *
  * This include file defines Classic API interfaces to Object Services.
  */
diff --git a/cpukit/include/rtems/rtems/options.h b/cpukit/include/rtems/rtems/options.h
index de47c320ba..a2d0e6d482 100644
--- a/cpukit/include/rtems/rtems/options.h
+++ b/cpukit/include/rtems/rtems/options.h
@@ -1,10 +1,7 @@
 /**
  * @file
  *
- * @defgroup ClassicOptions Classic API Options
- *
- * @ingroup ClassicRTEMS
- * @brief Options Available on Many Directives
+ * @addtogroup ClassicOptions
  *
  * This include file contains information which defines the
  * options available on many directives.
diff --git a/cpukit/include/rtems/rtems/ratemon.h b/cpukit/include/rtems/rtems/ratemon.h
index 81d26a6ace..062602c314 100644
--- a/cpukit/include/rtems/rtems/ratemon.h
+++ b/cpukit/include/rtems/rtems/ratemon.h
@@ -1,10 +1,7 @@
 /**
  * @file
  *
- * @defgroup ClassicRateMon Rate Monotonic Scheduler
- *
- * @ingroup ClassicRTEMS
- * @brief Classic API Rate Monotonic Manager.
+ * @addtogroup ClassicRateMon
  *
  * This include file contains all the constants, structures, and
  * prototypes associated with the Rate Monotonic Manager. This manager
diff --git a/cpukit/include/rtems/rtems/semmp.h b/cpukit/include/rtems/rtems/semmp.h
index e84ea127ea..a3bfb5e13d 100644
--- a/cpukit/include/rtems/rtems/semmp.h
+++ b/cpukit/include/rtems/rtems/semmp.h
@@ -1,10 +1,7 @@
 /**
  * @file
  *
- * @defgroup ClassicSEM Semaphore MP Support
- *
- * @ingroup ClassicRTEMS
- * @brief Semaphore Manager MP Support
+ * @addtogroup 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/status.h b/cpukit/include/rtems/rtems/status.h
index 646a382b38..c4175dcc2b 100644
--- a/cpukit/include/rtems/rtems/status.h
+++ b/cpukit/include/rtems/rtems/status.h
@@ -1,10 +1,7 @@
 /**
  * @file
  *
- * @defgroup ClassicStatus Status Codes
- *
- * @ingroup ClassicRTEMS
- * @brief Status Codes Returned from Executive Directives
+ * @addtogroup ClassicStatus
  *
  * This include file contains the status codes returned from the
  * executive directives.
diff --git a/cpukit/include/rtems/rtems/support.h b/cpukit/include/rtems/rtems/support.h
index 4ebb50cbdf..5834dba9e0 100644
--- a/cpukit/include/rtems/rtems/support.h
+++ b/cpukit/include/rtems/rtems/support.h
@@ -1,10 +1,7 @@
 /**
  * @file
  *
- * @defgroup ClassicRTEMSWorkspace Workspace
- *
- * @ingroup ClassicRTEMS
- * @brief Classic API support.
+ * @addtogroup ClassicRTEMSWorkspace
  */
 
 /* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/include/rtems/rtems/taskmp.h b/cpukit/include/rtems/rtems/taskmp.h
index c268fc6551..346b24f303 100644
--- a/cpukit/include/rtems/rtems/taskmp.h
+++ b/cpukit/include/rtems/rtems/taskmp.h
@@ -1,10 +1,7 @@
 /**
  * @file
  *
- * @defgroup ClassicTaskMP Task MP Support
- *
- * @ingroup ClassicRTEMS
- * @brief Task Manager MP Support
+ * @addtogroup ClassicTaskMP
  *
  * This include file contains all the constants and structures associated
  * with the multiprocessing support in the task manager.
-- 
2.16.4

More information about the devel mailing list