[PATCH 2/2] bsp/altera-cyclone-v: Adjust Doxygen groups
Sebastian Huber
sebastian.huber at embedded-brains.de
Wed Feb 27 09:05:20 UTC 2019
Update #3706
---
bsps/arm/altera-cyclone-v/include/bsp.h | 26 +++++++++++++-------------
bsps/arm/altera-cyclone-v/include/bsp/hwlib.h | 10 ++++------
bsps/arm/altera-cyclone-v/include/bsp/i2cdrv.h | 2 +-
bsps/arm/altera-cyclone-v/include/bsp/irq.h | 2 +-
bsps/arm/altera-cyclone-v/include/tm27.h | 2 +-
5 files changed, 20 insertions(+), 22 deletions(-)
diff --git a/bsps/arm/altera-cyclone-v/include/bsp.h b/bsps/arm/altera-cyclone-v/include/bsp.h
index 523f667142..4a74203d3f 100644
--- a/bsps/arm/altera-cyclone-v/include/bsp.h
+++ b/bsps/arm/altera-cyclone-v/include/bsp.h
@@ -1,9 +1,7 @@
/**
* @file
*
- * @ingroup arm_altera-cyclone-v
- *
- * @brief Global BSP definitions.
+ * @ingroup RTEMSBSPsARMCycV
*/
/*
@@ -23,6 +21,16 @@
#ifndef LIBBSP_ARM_ALTERA_CYCLONE_V_BSP_H
#define LIBBSP_ARM_ALTERA_CYCLONE_V_BSP_H
+/**
+ * @defgroup RTEMSBSPsARMCycV Intel Cyclone V
+ *
+ * @ingroup RTEMSBSPsARM
+ *
+ * @brief Intel Cyclone V board support package.
+ *
+ * @{
+ */
+
#include <bspopts.h>
#define BSP_FEATURE_IRQ_EXTENSION
@@ -61,14 +69,6 @@ extern uint32_t altera_cyclone_v_a9mpcore_periphclk;
#endif /* ASM */
-#endif /* LIBBSP_ARM_ALTERA_CYCLONE_V_BSP_H */
+/* @{ */
-/**
- * @defgroup arm_altera-cyclone-v Altera Cyclone V Support
- *
- * @ingroup bsp_arm
- *
- * @brief Altera Cyclone V support package.
- *
- * @{
- */
+#endif /* LIBBSP_ARM_ALTERA_CYCLONE_V_BSP_H */
diff --git a/bsps/arm/altera-cyclone-v/include/bsp/hwlib.h b/bsps/arm/altera-cyclone-v/include/bsp/hwlib.h
index 8aad5d7b32..2d0e978f3e 100644
--- a/bsps/arm/altera-cyclone-v/include/bsp/hwlib.h
+++ b/bsps/arm/altera-cyclone-v/include/bsp/hwlib.h
@@ -1,9 +1,7 @@
/**
* @file
*
- * @ingroup altera-cyclone-v_hwlib
- *
- * @brief The type definition for status codes returned by the HWLIB.
+ * @ingroup RTEMSBSPsARMCycVContrib
*/
/******************************************************************************
@@ -57,11 +55,11 @@ extern "C"
#endif /* __cplusplus */
/**
- * @defgroup altera-cyclone-v_hwlib Hwlib
+ * @defgroup RTEMSBSPsARMCycVContrib Contributed Code
*
- * @ingroup arm_altera-cyclone-v
+ * @ingroup RTEMSBSPsARMCycV
*
- * @brief The type definition for status codes returned by the HWLIB.
+ * @brief Contributed code from Altera.
*/
/*!
diff --git a/bsps/arm/altera-cyclone-v/include/bsp/i2cdrv.h b/bsps/arm/altera-cyclone-v/include/bsp/i2cdrv.h
index 114d8a6219..a9eea7deec 100644
--- a/bsps/arm/altera-cyclone-v/include/bsp/i2cdrv.h
+++ b/bsps/arm/altera-cyclone-v/include/bsp/i2cdrv.h
@@ -32,7 +32,7 @@ extern "C" {
/**
* @defgroup altera-cyclone-v_i2c I2C Support
*
- * @ingroup arm_altera-cyclone-v
+ * @ingroup RTEMSBSPsARMCycV
*
* @brief I2C Support
*
diff --git a/bsps/arm/altera-cyclone-v/include/bsp/irq.h b/bsps/arm/altera-cyclone-v/include/bsp/irq.h
index ad0e4dfd61..e85fda7033 100644
--- a/bsps/arm/altera-cyclone-v/include/bsp/irq.h
+++ b/bsps/arm/altera-cyclone-v/include/bsp/irq.h
@@ -39,7 +39,7 @@ extern "C" {
/**
* @defgroup altera-cyclone-v_interrupt Interrupt Support
*
- * @ingroup arm_altera-cyclone-v
+ * @ingroup RTEMSBSPsARMCycV
*
* @ingroup bsp_interrupt
*
diff --git a/bsps/arm/altera-cyclone-v/include/tm27.h b/bsps/arm/altera-cyclone-v/include/tm27.h
index 35f8cf0676..54c58761fa 100644
--- a/bsps/arm/altera-cyclone-v/include/tm27.h
+++ b/bsps/arm/altera-cyclone-v/include/tm27.h
@@ -10,7 +10,7 @@
/**
* @defgroup altera-cyclone-v_tm27 GIC tmtests/tm27
*
- * @ingroup arm_altera-cyclone-v
+ * @ingroup RTEMSBSPsARMCycV
*
* @brief GIC tmtests/tm27 support.
*/
--
2.16.4
More information about the devel
mailing list