doxygen: Add Doxygen files to a group

Update #3707.
This commit is contained in:
Sebastian Huber
2023-02-14 16:48:07 +01:00
parent 809e34e527
commit bb465c8548
26 changed files with 211 additions and 2 deletions

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines BSP-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsARMCycVContrib Contributed Code * @defgroup RTEMSBSPsARMCycVContrib Contributed Code
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines BSP-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsARMAtsamContrib Contributed Code * @defgroup RTEMSBSPsARMAtsamContrib Contributed Code
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines BSP-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsARM ARM * @defgroup RTEMSBSPsARM ARM
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines bfin-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsBfin Blackfin * @defgroup RTEMSBSPsBfin Blackfin
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines i386-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsI386 i386 * @defgroup RTEMSBSPsI386 i386
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines lm32-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsLM32 LatticeMicro32 (lm32) * @defgroup RTEMSBSPsLM32 LatticeMicro32 (lm32)
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines m68k-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsM68k Motorola 68000 and NXP ColdFire (m68k) * @defgroup RTEMSBSPsM68k Motorola 68000 and NXP ColdFire (m68k)
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines mips-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsMIPS MIPS * @defgroup RTEMSBSPsMIPS MIPS
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines moxie-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsMoxie Moxie * @defgroup RTEMSBSPsMoxie Moxie
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines nios2-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsNios2 Nios II (nios2) * @defgroup RTEMSBSPsNios2 Nios II (nios2)
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines no_cpu-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsNoCPU Example * @defgroup RTEMSBSPsNoCPU Example
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines or1k-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsOR1K OpenRISC 1000 (or1k) * @defgroup RTEMSBSPsOR1K OpenRISC 1000 (or1k)
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines powerpc-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsPowerPC PowerPC * @defgroup RTEMSBSPsPowerPC PowerPC
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines VME-specific groups.
*/
/** /**
* @defgroup shared_vmeuniverse VME Universe Modules * @defgroup shared_vmeuniverse VME Universe Modules
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines riscv-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsRISCV RISC-V * @defgroup RTEMSBSPsRISCV RISC-V
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines sh-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsSH SuperH (sh) * @defgroup RTEMSBSPsSH SuperH (sh)
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines BSP-specific groups.
*/
/** /**
* @defgroup RTEMSBSPs Board Support Packages * @defgroup RTEMSBSPs Board Support Packages
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines sparc-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsSPARC SPARC * @defgroup RTEMSBSPsSPARC SPARC
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines sparc64-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsSPARC64mm MM * @defgroup RTEMSBSPsSPARC64mm MM
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines sparc64-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsSPARC64 SPARC64 * @defgroup RTEMSBSPsSPARC64 SPARC64
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines v850-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsV850 V850 * @defgroup RTEMSBSPsV850 V850
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines x86_64-specific groups.
*/
/** /**
* @defgroup RTEMSBSPsX8664 x86-64 * @defgroup RTEMSBSPsX8664 x86-64
* *

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplDoxygen
*
* @brief This header file defines some Doxygen groups.
*/
/** /**
* @defgroup RTEMSAPIIO IO * @defgroup RTEMSAPIIO IO
* *

View File

@@ -1,5 +1,13 @@
/* SPDX-License-Identifier: BSD-2-Clause */ /* 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) 2019, 2023 embedded brains GmbH (http://www.embedded-brains.de)
* Copyright (C) 2010 Gedare Bloom * Copyright (C) 2010 Gedare Bloom

View File

@@ -1,7 +1,15 @@
/* SPDX-License-Identifier: BSD-2-Clause */ /* 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 * Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions * modification, are permitted provided that the following conditions
@@ -44,6 +52,12 @@
* @brief This group contains the RTEMS implementation components. * @brief This group contains the RTEMS implementation components.
*/ */
/**
* @defgroup RTEMSImplDoxygen Doxygen Support
*
* @ingroup RTEMSImpl
*/
/** /**
* @defgroup RTEMSTestSuites Test Suites * @defgroup RTEMSTestSuites Test Suites
* *

View File

@@ -3,7 +3,10 @@
/** /**
* @file * @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.
*/ */
/* /*