[rtems commit] bsps/arm: Adjust CMSIS Doxygen groups

Sebastian Huber sebh at rtems.org
Fri Mar 8 07:01:57 UTC 2019


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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Thu Mar  7 11:56:31 2019 +0100

bsps/arm: Adjust CMSIS Doxygen groups

Update #3706.

---

 bsps/arm/include/cmsis_gcc.h    | 2 ++
 bsps/arm/include/core_cm7.h     | 3 +++
 bsps/arm/include/core_cmInstr.h | 1 +
 bsps/arm/include/core_cmSimd.h  | 1 +
 bsps/arm/shared/doxygen.h       | 8 ++++++++
 5 files changed, 15 insertions(+)

diff --git a/bsps/arm/include/cmsis_gcc.h b/bsps/arm/include/cmsis_gcc.h
index 5c362f4..ea32ae7 100644
--- a/bsps/arm/include/cmsis_gcc.h
+++ b/bsps/arm/include/cmsis_gcc.h
@@ -351,6 +351,7 @@ __attribute__( ( always_inline ) ) __STATIC_INLINE void __set_FPSCR(uint32_t fps
 
 /* ##########################  Core Instruction Access  ######################### */
 /** \defgroup CMSIS_Core_InstructionInterface CMSIS Core Instruction Interface
+  \ingroup CMSIS
   Access to dedicated instructions
   @{
 */
@@ -823,6 +824,7 @@ __attribute__((always_inline)) __STATIC_INLINE void __STRT(uint32_t value, volat
 
 /* ###################  Compiler specific Intrinsics  ########################### */
 /** \defgroup CMSIS_SIMD_intrinsics CMSIS SIMD Intrinsics
+  \ingroup CMSIS
   Access to dedicated SIMD instructions
   @{
 */
diff --git a/bsps/arm/include/core_cm7.h b/bsps/arm/include/core_cm7.h
index 4cf635c..3ffef85 100644
--- a/bsps/arm/include/core_cm7.h
+++ b/bsps/arm/include/core_cm7.h
@@ -272,6 +272,7 @@
 /* IO definitions (access restrictions to peripheral registers) */
 /**
     \defgroup CMSIS_glob_defs CMSIS Global Defines
+    \ingroup CMSIS
 
     <strong>IO Type Qualifiers</strong> are used
     \li to specify the access to peripheral variables.
@@ -307,6 +308,7 @@
  ******************************************************************************/
 /**
   \defgroup CMSIS_core_register Defines and Type Definitions
+  \ingroup CMSIS
   \brief Type definitions and defines for Cortex-M processor based devices.
 */
 
@@ -1780,6 +1782,7 @@ typedef struct
  ******************************************************************************/
 /**
   \defgroup CMSIS_Core_FunctionInterface Functions and Instructions Reference
+  \ingroup CMSIS
 */
 
 
diff --git a/bsps/arm/include/core_cmInstr.h b/bsps/arm/include/core_cmInstr.h
index 7e88e6c..0bf0e50 100644
--- a/bsps/arm/include/core_cmInstr.h
+++ b/bsps/arm/include/core_cmInstr.h
@@ -44,6 +44,7 @@
 
 /* ##########################  Core Instruction Access  ######################### */
 /** \defgroup CMSIS_Core_InstructionInterface CMSIS Core Instruction Interface
+  \ingroup CMSIS
   Access to dedicated instructions
   @{
 */
diff --git a/bsps/arm/include/core_cmSimd.h b/bsps/arm/include/core_cmSimd.h
index bef78ab..08f9e9a 100644
--- a/bsps/arm/include/core_cmSimd.h
+++ b/bsps/arm/include/core_cmSimd.h
@@ -48,6 +48,7 @@
 
 /* ###################  Compiler specific Intrinsics  ########################### */
 /** \defgroup CMSIS_SIMD_intrinsics CMSIS SIMD Intrinsics
+  \ingroup CMSIS
   Access to dedicated SIMD instructions
   @{
 */
diff --git a/bsps/arm/shared/doxygen.h b/bsps/arm/shared/doxygen.h
index f8cb013..6617afa 100644
--- a/bsps/arm/shared/doxygen.h
+++ b/bsps/arm/shared/doxygen.h
@@ -13,3 +13,11 @@
  *
  * @brief Shared Support for ARM Board Support Packages.
  */
+
+/**
+ * @defgroup CMSIS CMSIS
+ *
+ * @ingroup RTEMSBSPsARMShared
+ *
+ * @brief Cortex Microcontroller Software Interface Standard (CMSIS).
+ */



More information about the vc mailing list