[rtems commit] doxygen: Add files to groups and fix group scopes

Sebastian Huber sebh at rtems.org
Fri Mar 17 07:30:28 UTC 2023


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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Thu Mar 16 11:10:57 2023 +0100

doxygen: Add files to groups and fix group scopes

---

 cpukit/include/rtems/libcsupport.h    | 8 +++++---
 cpukit/include/rtems/print.h          | 4 ++++
 cpukit/include/rtems/printer.h        | 2 ++
 cpukit/include/rtems/score/timespec.h | 2 +-
 4 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/cpukit/include/rtems/libcsupport.h b/cpukit/include/rtems/libcsupport.h
index 67a09dc2a2..9329b82674 100644
--- a/cpukit/include/rtems/libcsupport.h
+++ b/cpukit/include/rtems/libcsupport.h
@@ -2,9 +2,11 @@
 
 /**
  * @file
- * 
+ *
+ * @ingroup libcsupport
+ *
  * @brief Standard C Library Support
- * 
+ *
  * This include file contains the information regarding the
  * RTEMS specific support for the standard C library.
  */
@@ -55,8 +57,8 @@ extern "C" {
  *
  * @brief RTEMS Specific Support for the Standard C Library
  *
+ * @{
  */
-/**@{**/
 
 extern void malloc_dump(void);
 
diff --git a/cpukit/include/rtems/print.h b/cpukit/include/rtems/print.h
index ee9fa366b7..1f870482d4 100644
--- a/cpukit/include/rtems/print.h
+++ b/cpukit/include/rtems/print.h
@@ -3,6 +3,8 @@
 /**
  * @file
  *
+ * @ingroup RTEMSPrintSupport
+ *
  * @brief User print interface to the bspIO print plug in.
  *
  * This include file defines the user interface to kernel print methods.
@@ -54,6 +56,8 @@ typedef struct rtems_printer rtems_printer;
  *
  * This module contains all methods and support related to providing the user
  * with an interface to the kernel level print support.
+ *
+ * @{
  */
 
 /**
diff --git a/cpukit/include/rtems/printer.h b/cpukit/include/rtems/printer.h
index 2c6e68060d..424d59563e 100644
--- a/cpukit/include/rtems/printer.h
+++ b/cpukit/include/rtems/printer.h
@@ -3,6 +3,8 @@
 /**
  * @file
  *
+ * @ingroup RTEMSPrintSupport
+ *
  * @brief User print interface to the bspIO print plug in.
  *
  * This include file defines the user interface to kernel print methods.
diff --git a/cpukit/include/rtems/score/timespec.h b/cpukit/include/rtems/score/timespec.h
index 2090f19b32..2e419d69de 100644
--- a/cpukit/include/rtems/score/timespec.h
+++ b/cpukit/include/rtems/score/timespec.h
@@ -3,7 +3,7 @@
 /**
  * @file
  *
- * @ingroup Timespec
+ * @ingroup RTEMSScoreTimespec
  *
  * @brief This header file provides the interfaces of the
  * @ref RTEMSScoreTimespec.



More information about the vc mailing list