[PATCH] doxygen: Add Doxygen files to a group

Sebastian Huber sebastian.huber at embedded-brains.de
Tue Feb 14 15:48:35 UTC 2023 

---
 bsps/arm/altera-cyclone-v/contrib/doxygen.h |  8 ++++++++
 bsps/arm/atsam/contrib/doxygen.h            |  8 ++++++++
 bsps/arm/shared/doxygen.h                   |  8 ++++++++
 bsps/bfin/shared/doxygen.h                  |  8 ++++++++
 bsps/i386/shared/doxygen.h                  |  8 ++++++++
 bsps/lm32/shared/doxygen.h                  |  8 ++++++++
 bsps/m68k/shared/doxygen.h                  |  8 ++++++++
 bsps/mips/shared/doxygen.h                  |  8 ++++++++
 bsps/moxie/shared/doxygen.h                 |  8 ++++++++
 bsps/nios2/shared/doxygen.h                 |  8 ++++++++
 bsps/no_cpu/shared/doxygen.h                |  8 ++++++++
 bsps/or1k/shared/doxygen.h                  |  8 ++++++++
 bsps/powerpc/shared/doxygen.h               |  8 ++++++++
 bsps/powerpc/shared/vme/doxygen.h           |  8 ++++++++
 bsps/riscv/shared/doxygen.h                 |  8 ++++++++
 bsps/sh/shared/doxygen.h                    |  8 ++++++++
 bsps/shared/doxygen.h                       |  8 ++++++++
 bsps/sparc/shared/doxygen.h                 |  8 ++++++++
 bsps/sparc64/include/arch/mm/doxygen.h      |  8 ++++++++
 bsps/sparc64/shared/doxygen.h               |  8 ++++++++
 bsps/v850/shared/doxygen.h                  |  8 ++++++++
 bsps/x86_64/shared/doxygen.h                |  8 ++++++++
 cpukit/doxygen.h                            |  8 ++++++++
 cpukit/doxygen/appl-config.h                |  8 ++++++++
 cpukit/doxygen/top-level-groups.h           | 16 +++++++++++++++-
 cpukit/include/rtems/rtems/mainpage.h       |  5 ++++-
 26 files changed, 211 insertions(+), 2 deletions(-)

diff --git a/bsps/arm/altera-cyclone-v/contrib/doxygen.h b/bsps/arm/altera-cyclone-v/contrib/doxygen.h
index 7c3874cc4f..aab3f633ae 100644
--- a/bsps/arm/altera-cyclone-v/contrib/doxygen.h
+++ b/bsps/arm/altera-cyclone-v/contrib/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines BSP-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsARMCycVContrib Contributed Code
  *
diff --git a/bsps/arm/atsam/contrib/doxygen.h b/bsps/arm/atsam/contrib/doxygen.h
index ff8c9bd584..9ca6b227ed 100644
--- a/bsps/arm/atsam/contrib/doxygen.h
+++ b/bsps/arm/atsam/contrib/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines BSP-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsARMAtsamContrib Contributed Code
  *
diff --git a/bsps/arm/shared/doxygen.h b/bsps/arm/shared/doxygen.h
index 6617afa816..469928d712 100644
--- a/bsps/arm/shared/doxygen.h
+++ b/bsps/arm/shared/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines BSP-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsARM ARM
  *
diff --git a/bsps/bfin/shared/doxygen.h b/bsps/bfin/shared/doxygen.h
index 0a33c97a93..4ada8402e9 100644
--- a/bsps/bfin/shared/doxygen.h
+++ b/bsps/bfin/shared/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines bfin-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsBfin Blackfin
  *
diff --git a/bsps/i386/shared/doxygen.h b/bsps/i386/shared/doxygen.h
index f38008e6cd..28ca401d02 100644
--- a/bsps/i386/shared/doxygen.h
+++ b/bsps/i386/shared/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines i386-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsI386 i386
  *
diff --git a/bsps/lm32/shared/doxygen.h b/bsps/lm32/shared/doxygen.h
index 73584e9293..159f21504c 100644
--- a/bsps/lm32/shared/doxygen.h
+++ b/bsps/lm32/shared/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines lm32-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsLM32 LatticeMicro32 (lm32)
  *
diff --git a/bsps/m68k/shared/doxygen.h b/bsps/m68k/shared/doxygen.h
index 573ec104ec..400a2852ca 100644
--- a/bsps/m68k/shared/doxygen.h
+++ b/bsps/m68k/shared/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines m68k-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsM68k Motorola 68000 and NXP ColdFire (m68k)
  *
diff --git a/bsps/mips/shared/doxygen.h b/bsps/mips/shared/doxygen.h
index ee699fb556..9747c635a9 100644
--- a/bsps/mips/shared/doxygen.h
+++ b/bsps/mips/shared/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines mips-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsMIPS MIPS
  *
diff --git a/bsps/moxie/shared/doxygen.h b/bsps/moxie/shared/doxygen.h
index e60a556d28..489dc9a702 100644
--- a/bsps/moxie/shared/doxygen.h
+++ b/bsps/moxie/shared/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines moxie-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsMoxie Moxie
  *
diff --git a/bsps/nios2/shared/doxygen.h b/bsps/nios2/shared/doxygen.h
index 5dd48fb2b2..b8f3f3a345 100644
--- a/bsps/nios2/shared/doxygen.h
+++ b/bsps/nios2/shared/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines nios2-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsNios2 Nios II (nios2)
  *
diff --git a/bsps/no_cpu/shared/doxygen.h b/bsps/no_cpu/shared/doxygen.h
index 4d2f5f96d3..bce541f8f0 100644
--- a/bsps/no_cpu/shared/doxygen.h
+++ b/bsps/no_cpu/shared/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines no_cpu-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsNoCPU Example
  *
diff --git a/bsps/or1k/shared/doxygen.h b/bsps/or1k/shared/doxygen.h
index d380bfa744..2c1ce043de 100644
--- a/bsps/or1k/shared/doxygen.h
+++ b/bsps/or1k/shared/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines or1k-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsOR1K OpenRISC 1000 (or1k)
  *
diff --git a/bsps/powerpc/shared/doxygen.h b/bsps/powerpc/shared/doxygen.h
index ca5c2b2a58..d4a7794bc8 100644
--- a/bsps/powerpc/shared/doxygen.h
+++ b/bsps/powerpc/shared/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines powerpc-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsPowerPC PowerPC
  *
diff --git a/bsps/powerpc/shared/vme/doxygen.h b/bsps/powerpc/shared/vme/doxygen.h
index c87183464b..8e458ffd88 100644
--- a/bsps/powerpc/shared/vme/doxygen.h
+++ b/bsps/powerpc/shared/vme/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines VME-specific groups.
+ */
+
 /**
  *  @defgroup shared_vmeuniverse VME Universe Modules
  *
diff --git a/bsps/riscv/shared/doxygen.h b/bsps/riscv/shared/doxygen.h
index dc95013d05..1f206ad638 100644
--- a/bsps/riscv/shared/doxygen.h
+++ b/bsps/riscv/shared/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines riscv-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsRISCV RISC-V
  *
diff --git a/bsps/sh/shared/doxygen.h b/bsps/sh/shared/doxygen.h
index ae5d985f81..e529f13080 100644
--- a/bsps/sh/shared/doxygen.h
+++ b/bsps/sh/shared/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines sh-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsSH SuperH (sh)
  *
diff --git a/bsps/shared/doxygen.h b/bsps/shared/doxygen.h
index d3679c2f3d..be681673d0 100644
--- a/bsps/shared/doxygen.h
+++ b/bsps/shared/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines BSP-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPs Board Support Packages
  *
diff --git a/bsps/sparc/shared/doxygen.h b/bsps/sparc/shared/doxygen.h
index 100a9b6c18..4ed2ae7285 100644
--- a/bsps/sparc/shared/doxygen.h
+++ b/bsps/sparc/shared/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines sparc-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsSPARC SPARC
  *
diff --git a/bsps/sparc64/include/arch/mm/doxygen.h b/bsps/sparc64/include/arch/mm/doxygen.h
index d6872dff07..fbdb721d20 100644
--- a/bsps/sparc64/include/arch/mm/doxygen.h
+++ b/bsps/sparc64/include/arch/mm/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines sparc64-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsSPARC64mm MM
  * 
diff --git a/bsps/sparc64/shared/doxygen.h b/bsps/sparc64/shared/doxygen.h
index 0bfccebf9f..33fa0b3fe8 100644
--- a/bsps/sparc64/shared/doxygen.h
+++ b/bsps/sparc64/shared/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines sparc64-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsSPARC64 SPARC64
  *
diff --git a/bsps/v850/shared/doxygen.h b/bsps/v850/shared/doxygen.h
index beaaa35275..c52818ea50 100644
--- a/bsps/v850/shared/doxygen.h
+++ b/bsps/v850/shared/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines v850-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsV850 V850
  *
diff --git a/bsps/x86_64/shared/doxygen.h b/bsps/x86_64/shared/doxygen.h
index 7cb74a1017..d17ca3fbb6 100644
--- a/bsps/x86_64/shared/doxygen.h
+++ b/bsps/x86_64/shared/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines x86_64-specific groups.
+ */
+
 /**
  * @defgroup RTEMSBSPsX8664 x86-64
  *
diff --git a/cpukit/doxygen.h b/cpukit/doxygen.h
index a60d138c03..661955a501 100644
--- a/cpukit/doxygen.h
+++ b/cpukit/doxygen.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines some Doxygen groups.
+ */
+
 /**
  * @defgroup RTEMSAPIIO IO
  *
diff --git a/cpukit/doxygen/appl-config.h b/cpukit/doxygen/appl-config.h
index 5c76761453..2690b67d21 100644
--- a/cpukit/doxygen/appl-config.h
+++ b/cpukit/doxygen/appl-config.h
@@ -1,5 +1,13 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file documents the application configuration options.
+ */
+
 /*
  * Copyright (C) 2019, 2023 embedded brains GmbH (http://www.embedded-brains.de)
  * Copyright (C) 2010 Gedare Bloom
diff --git a/cpukit/doxygen/top-level-groups.h b/cpukit/doxygen/top-level-groups.h
index 8d38195f3e..8a439feee1 100644
--- a/cpukit/doxygen/top-level-groups.h
+++ b/cpukit/doxygen/top-level-groups.h
@@ -1,7 +1,15 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines high level Doxygen groups.
+ */
+
 /*
- * Copyright (C) 2019, 2020 embedded brains GmbH (http://www.embedded-brains.de)
+ * Copyright (C) 2019, 2023 embedded brains GmbH (http://www.embedded-brains.de)
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
@@ -44,6 +52,12 @@
  * @brief This group contains the RTEMS implementation components.
  */
 
+/**
+ * @defgroup RTEMSImplDoxygen Doxygen Support
+ *
+ * @ingroup RTEMSImpl
+ */
+
 /**
  * @defgroup RTEMSTestSuites Test Suites
  *
diff --git a/cpukit/include/rtems/rtems/mainpage.h b/cpukit/include/rtems/rtems/mainpage.h
index 313f4303c6..f168cc3395 100644
--- a/cpukit/include/rtems/rtems/mainpage.h
+++ b/cpukit/include/rtems/rtems/mainpage.h
@@ -3,7 +3,10 @@
 /**
  * @file
  *
- * This file exists to provide a top level description of RTEMS for Doxygen.
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This file exists to provide a top level description of RTEMS for
+ *   Doxygen.
  */
 
 /*
-- 
2.35.3

More information about the devel mailing list