[rtems commit] doxygen: Use common syntax for groups
Sebastian Huber
sebh at rtems.org
Mon Nov 23 09:42:22 UTC 2020
Module: rtems
Branch: master
Commit: 6c078901b2a2e40380e918646205916f16488256
Changeset: http://git.rtems.org/rtems/commit/?id=6c078901b2a2e40380e918646205916f16488256
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Tue Oct 13 15:48:14 2020 +0200
doxygen: Use common syntax for groups
---
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 28bd499..d3679c2 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 2916ec0..8d38195 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.
*/
More information about the vc
mailing list