[rtems commit] doxygen: Added some subgroups to API and IO

Sebastian Huber sebh at rtems.org
Thu Apr 4 06:27:36 UTC 2019


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

Author:    Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date:      Tue Apr  2 13:43:08 2019 +0200

doxygen: Added some subgroups to API and IO

I2C library, Media Manager and Profiling Support

Update #3706.

---

 cpukit/include/rtems/libi2c.h    | 8 +++++---
 cpukit/include/rtems/media.h     | 8 +++++---
 cpukit/include/rtems/profiling.h | 2 ++
 3 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/cpukit/include/rtems/libi2c.h b/cpukit/include/rtems/libi2c.h
index 341e390..7b86ab5 100644
--- a/cpukit/include/rtems/libi2c.h
+++ b/cpukit/include/rtems/libi2c.h
@@ -3,7 +3,7 @@
  *
  * @ingroup libi2c
  *
- * @brief I2C Library
+ * @brief Legacy I2C Library
  */
 
 #ifndef _RTEMS_LIBI2C_H
@@ -63,9 +63,11 @@ extern "C" {
 #endif
 
 /**
- * @defgroup libi2c I2C Library
+ * @defgroup libi2c Legacy I2C Library
  *
- * @brief I2C library.
+ * @ingroup RTEMSDeviceDrivers
+ *
+ * @brief Legacy I2C library.
  *
  */
 /**@{**/
diff --git a/cpukit/include/rtems/media.h b/cpukit/include/rtems/media.h
index 0fbc564..b2a3e2d 100644
--- a/cpukit/include/rtems/media.h
+++ b/cpukit/include/rtems/media.h
@@ -1,9 +1,9 @@
 /**
  * @file
  *
- * @ingroup RTEMSMedia
+ * @ingroup RTEMSIOMedia
  *
- * @brief Media API.
+ * @brief Media Manager API.
  */
 
 /*
@@ -31,7 +31,9 @@ extern "C" {
 #endif /* __cplusplus */
 
 /**
- * @defgroup RTEMSMedia Media Manager
+ * @defgroup RTEMSIOMedia Media Manager
+ *
+ * @ingroup LibIO
  *
  * @brief Removable media support.
  *
diff --git a/cpukit/include/rtems/profiling.h b/cpukit/include/rtems/profiling.h
index 9e434b2..3bad1ed 100644
--- a/cpukit/include/rtems/profiling.h
+++ b/cpukit/include/rtems/profiling.h
@@ -34,6 +34,8 @@ extern "C" {
 /**
  * @defgroup Profiling Profiling Support
  *
+ * @ingroup RTEMSAPI
+ *
  * @brief The profiling support offers functions to report profiling
  * information available in the system.
  *




More information about the vc mailing list