[PATCH 02/20] doxygen: Use common syntax for groups

Sebastian Huber sebastian.huber at embedded-brains.de
Fri Nov 20 11:15:08 UTC 2020


---
 bsps/shared/doxygen.h             | 8 ++++----
 cpukit/doxygen/top-level-groups.h | 7 ++++---
 2 files changed, 8 insertions(+), 7 deletions(-)

diff --git a/bsps/shared/doxygen.h b/bsps/shared/doxygen.h
index 28bd4990f7..d3679c2f3d 100644
--- a/bsps/shared/doxygen.h
+++ b/bsps/shared/doxygen.h
@@ -1,8 +1,7 @@
 /**
  * @defgroup RTEMSBSPs Board Support Packages
  *
- * @brief Board Support Packages and Support Modules
- * (BSPs).
+ * @brief This group contains the Board Support Packages (BSPs).
  */
 
 /**
@@ -10,7 +9,8 @@
  *
  * @ingroup RTEMSBSPs
  *
- * @brief Shared Support for Board Support Packages
+ * @brief This group contains the architecture-independent support modules
+ *   shared across all BSPs.
  */
 
 /**
@@ -18,5 +18,5 @@
  *
  * @ingroup RTEMSBSPsShared
  *
- * @brief Console Driver Support for Board Support Packages.
+ * @brief This group contains the console driver support modules.
  */
diff --git a/cpukit/doxygen/top-level-groups.h b/cpukit/doxygen/top-level-groups.h
index 2916ec0b90..8d38195f3e 100644
--- a/cpukit/doxygen/top-level-groups.h
+++ b/cpukit/doxygen/top-level-groups.h
@@ -28,13 +28,14 @@
 /**
  * @defgroup RTEMSAPI API
  *
- * @brief API
+ * @brief This group contains the Application Programming Interfaces (APIs) of
+ *   RTEMS.
  */
 
 /**
  * @defgroup RTEMSDeviceDrivers Device Drivers
  *
- * @brief Device Drivers
+ * @brief This group contains the device drivers.
  */
 
 /**
@@ -46,5 +47,5 @@
 /**
  * @defgroup RTEMSTestSuites Test Suites
  *
- * @brief Collection of Test Suites
+ * @brief This group contains the test suites.
  */
-- 
2.26.2



More information about the devel mailing list