[PATCH 28/28] doxygen: Split up "libmisc" subgroups and removed libmisc

Sebastian Huber sebastian.huber at embedded-brains.de
Wed Apr 3 07:32:01 UTC 2019


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

Update #3706.
---
 cpukit/doxygen.h                  | 8 --------
 cpukit/include/rtems/bspcmdline.h | 4 +++-
 cpukit/include/rtems/cpuuse.h     | 7 +++----
 cpukit/include/rtems/dumpbuf.h    | 2 +-
 cpukit/include/rtems/mw_uid.h     | 7 +++----
 cpukit/include/rtems/stackchk.h   | 7 +++----
 cpukit/include/rtems/stringto.h   | 7 +++----
 cpukit/include/rtems/untar.h      | 2 +-
 8 files changed, 17 insertions(+), 27 deletions(-)

diff --git a/cpukit/doxygen.h b/cpukit/doxygen.h
index 658c1c1dcd..ece21ef03d 100644
--- a/cpukit/doxygen.h
+++ b/cpukit/doxygen.h
@@ -80,14 +80,6 @@
  * @brief nfs Client
  */
 
-/**
- * @defgroup libmisc libmisc
- * 
- * @ingroup TODO
- * 
- * @brief libmisc
- */
-
 /**
  * @defgroup libmisc_mouse Serial Mouse
  * 
diff --git a/cpukit/include/rtems/bspcmdline.h b/cpukit/include/rtems/bspcmdline.h
index 04b1a45640..04ad3d7ef2 100644
--- a/cpukit/include/rtems/bspcmdline.h
+++ b/cpukit/include/rtems/bspcmdline.h
@@ -1,5 +1,7 @@
 /**
  * @file
+ * 
+ * @ingroup BSPCommandLine
  *
  * @brief BSP Command Line Handler
  *
@@ -25,7 +27,7 @@
 /**
  * @defgroup BSPCommandLine BSP Command Line Helpers
  * 
- * @ingroup libmisc
+ * @ingroup RTEMSAPIClassic
  *
  * The BSP Command Line Handler provides a set of routines which assist
  * in examining and decoding the Command Line String passed to the BSP
diff --git a/cpukit/include/rtems/cpuuse.h b/cpukit/include/rtems/cpuuse.h
index 325ef0def3..a825005356 100644
--- a/cpukit/include/rtems/cpuuse.h
+++ b/cpukit/include/rtems/cpuuse.h
@@ -1,9 +1,8 @@
 /**
  * @file
  *
- * @defgroup libmisc_cpuuse CPU Usage
- *
- * @ingroup libmisc
+ * @ingroup libmisc_cpuuse
+ * 
  * @brief CPU Usage Report
  *
  * This include file contains information necessary to utilize
@@ -28,7 +27,7 @@
 /**
  *  @defgroup libmisc_cpuuse CPU Usage
  *
- *  @ingroup libmisc
+ *  @ingroup RTEMSAPIClassic
  */
 /**@{*/
 #ifdef __cplusplus
diff --git a/cpukit/include/rtems/dumpbuf.h b/cpukit/include/rtems/dumpbuf.h
index d714879ab4..690ac63341 100644
--- a/cpukit/include/rtems/dumpbuf.h
+++ b/cpukit/include/rtems/dumpbuf.h
@@ -22,7 +22,7 @@
 /**
  *  @defgroup libmisc_dumpbuf Print Memory Buffer
  *
- *  @ingroup libmisc
+ *  @ingroup RTEMSAPIPrintSupport
  */
 /**@{*/
 #ifdef __cplusplus
diff --git a/cpukit/include/rtems/mw_uid.h b/cpukit/include/rtems/mw_uid.h
index 2222494254..e90ef695a9 100644
--- a/cpukit/include/rtems/mw_uid.h
+++ b/cpukit/include/rtems/mw_uid.h
@@ -1,9 +1,8 @@
 /**
  * @file
  *
- * @defgroup libmisc_fb_mw Input Devices for MicroWindows
- *
- * @ingroup libmisc
+ * @ingroup libmisc_fb_mw
+ * 
  * @brief Input Devices for MicroWindows
  *
  * This file defines the interface for input devices used by MicroWindows
@@ -23,7 +22,7 @@
 /**
  *  @defgroup libmisc_fb_mw Input Devices for MicroWindows
  *
- *  @ingroup libmisc
+ *  @ingroup RTEMSDeviceDrivers
  */
 /**@{*/
 #ifdef __cplusplus
diff --git a/cpukit/include/rtems/stackchk.h b/cpukit/include/rtems/stackchk.h
index 22f2730481..700e557337 100644
--- a/cpukit/include/rtems/stackchk.h
+++ b/cpukit/include/rtems/stackchk.h
@@ -1,9 +1,8 @@
 /**
  * @file
  *
- * @defgroup libmisc_stackchk Stack Checker Mechanism
- *
- * @ingroup libmisc
+ * @ingroup libmisc_stackchk
+ * 
  * @brief Stack Checker Information
  *
  * This include file contains information necessary to utilize
@@ -30,7 +29,7 @@
 /**
  *  @defgroup libmisc_stackchk Stack Checker Mechanism
  *
- *  @ingroup libmisc
+ *  @ingroup RTEMSAPIClassic
  */
 /**@{*/
 #ifdef __cplusplus
diff --git a/cpukit/include/rtems/stringto.h b/cpukit/include/rtems/stringto.h
index 53e8147c81..7a220ea6b3 100644
--- a/cpukit/include/rtems/stringto.h
+++ b/cpukit/include/rtems/stringto.h
@@ -1,9 +1,8 @@
 /**
  * @file
  *
- * @defgroup libmisc_conv_help Conversion Helpers
- *
- * @ingroup libmisc
+ * @ingroup libmisc_conv_help
+ * 
  * @brief Convert String to Pointer (with validation)
  *
  * This file defines the interface to a set of string conversion helpers.
@@ -23,7 +22,7 @@
 /**
  *  @defgroup libmisc_conv_help Conversion Helpers
  *
- *  @ingroup libmisc
+ *  @ingroup RTEMSAPIClassic
  */
 /**@{*/
 
diff --git a/cpukit/include/rtems/untar.h b/cpukit/include/rtems/untar.h
index bc0a97c103..ba99eb04b9 100644
--- a/cpukit/include/rtems/untar.h
+++ b/cpukit/include/rtems/untar.h
@@ -28,7 +28,7 @@
 /**
  *  @defgroup libmisc_untar_img Untar Image
  *
- *  @ingroup libmisc
+ *  @ingroup LibIO
  */
 /**@{*/
 #ifdef __cplusplus
-- 
2.16.4



More information about the devel mailing list