[PATCH 4/5] bsp/altera-cyclone-v: Add Doxygen groups

Sebastian Huber sebastian.huber at embedded-brains.de
Thu Mar 7 12:51:52 UTC 2019


Add Doxygen groups for contributed code which would otherwise end up at
the top level.

Update #3706.
---
 bsps/arm/altera-cyclone-v/contrib/doxygen.h   | 85 +++++++++++++++++++++++++++
 bsps/arm/altera-cyclone-v/include/bsp/hwlib.h |  8 ---
 2 files changed, 85 insertions(+), 8 deletions(-)
 create mode 100644 bsps/arm/altera-cyclone-v/contrib/doxygen.h

diff --git a/bsps/arm/altera-cyclone-v/contrib/doxygen.h b/bsps/arm/altera-cyclone-v/contrib/doxygen.h
new file mode 100644
index 0000000000..7c3874cc4f
--- /dev/null
+++ b/bsps/arm/altera-cyclone-v/contrib/doxygen.h
@@ -0,0 +1,85 @@
+/**
+ * @defgroup RTEMSBSPsARMCycVContrib Contributed Code
+ *
+ * @ingroup RTEMSBSPsARMCycV
+ *
+ * @brief Contributed code from Altera.
+ */
+
+/**
+ * @defgroup CACHE_MGR Cache Management API
+ *
+ * @ingroup RTEMSBSPsARMCycVContrib
+ */
+
+/**
+ * @defgroup ALT_DMA DMA Controller API
+ *
+ * @ingroup RTEMSBSPsARMCycVContrib
+ */
+
+/**
+ * @defgroup ALT_DMA_COMMON DMA Controller Common API Definitions
+ *
+ * @ingroup RTEMSBSPsARMCycVContrib
+ */
+
+/**
+ * @defgroup ALT_DMA_PRG DMA Controller Programming API
+ *
+ * @ingroup RTEMSBSPsARMCycVContrib
+ */
+
+/**
+ * @defgroup ALT_I2C I2C Controller API
+ *
+ * @ingroup RTEMSBSPsARMCycVContrib
+ */
+
+/**
+ * @defgroup INT_COMMON Interrupt Controller Common Definitions
+ *
+ * @ingroup RTEMSBSPsARMCycVContrib
+ */
+
+/**
+ * @defgroup ALT_QSPI QSPI Flash Controller Module
+ *
+ * @ingroup RTEMSBSPsARMCycVContrib
+ */
+
+/**
+ * @defgroup ALT_SOCAL_UTIL SoCAL Utilities
+ *
+ * @ingroup RTEMSBSPsARMCycVContrib
+ */
+
+/**
+ * @defgroup ADDR_SPACE_MGR The Address Space Manager
+ *
+ * @ingroup RTEMSBSPsARMCycVContrib
+ */
+
+/**
+ * @defgroup CLK_MGR The Clock Manager API
+ *
+ * @ingroup RTEMSBSPsARMCycVContrib
+ */
+
+/**
+ * @defgroup ALT_GPIO_API The General Purpose Input/Output Manager API
+ *
+ * @ingroup RTEMSBSPsARMCycVContrib
+ */
+
+/**
+ * @defgroup RST_MGR The Reset Manager
+ *
+ * @ingroup RTEMSBSPsARMCycVContrib
+ */
+
+/**
+ * @defgroup UART UART Driver API
+ *
+ * @ingroup RTEMSBSPsARMCycVContrib
+ */
diff --git a/bsps/arm/altera-cyclone-v/include/bsp/hwlib.h b/bsps/arm/altera-cyclone-v/include/bsp/hwlib.h
index 2d0e978f3e..eca6395b3f 100644
--- a/bsps/arm/altera-cyclone-v/include/bsp/hwlib.h
+++ b/bsps/arm/altera-cyclone-v/include/bsp/hwlib.h
@@ -54,14 +54,6 @@ extern "C"
 {
 #endif  /* __cplusplus */
 
-/**
- * @defgroup RTEMSBSPsARMCycVContrib Contributed Code
- *
- * @ingroup RTEMSBSPsARMCycV
- *
- * @brief Contributed code from Altera.
- */
-
 /*!
  * The type definition for status codes returned by the HWLIB.
  */
-- 
2.16.4




More information about the devel mailing list