[PATCH] arm: realview-pbx-a9: Add doxygen

Chirayu Desai cdesai at cyanogenmod.org
Fri Dec 13 16:02:29 UTC 2013


---
 c/src/lib/libbsp/arm/realview-pbx-a9/include/bsp.h  | 17 +++++++++++++++++
 c/src/lib/libbsp/arm/realview-pbx-a9/include/irq.h  | 16 ++++++++++++++++
 c/src/lib/libbsp/arm/realview-pbx-a9/include/tm27.h | 17 +++++++++++++++++
 3 files changed, 50 insertions(+)

diff --git a/c/src/lib/libbsp/arm/realview-pbx-a9/include/bsp.h b/c/src/lib/libbsp/arm/realview-pbx-a9/include/bsp.h
index 05c0fd088d..c4f14d46ee 100644
--- a/c/src/lib/libbsp/arm/realview-pbx-a9/include/bsp.h
+++ b/c/src/lib/libbsp/arm/realview-pbx-a9/include/bsp.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup arm_realview-pbx-a9
+ *
+ * @brief Global BSP definitions.
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *
@@ -58,3 +66,12 @@ void rvpbxa9_fatal(rvpbxa9_fatal_code code) RTEMS_COMPILER_NO_RETURN_ATTRIBUTE;
 #endif /* ASM */
 
 #endif /* LIBBSP_ARM_REALVIEW_PBX_A9_BSP_H */
+
+/**
+ * @defgroup arm_realview-pbx-a9 Realview PBX-A9
+ *
+ * @ingroup bsp_arm
+ *
+ * @brief Realview PBX-A9 support package
+ *
+ */
diff --git a/c/src/lib/libbsp/arm/realview-pbx-a9/include/irq.h b/c/src/lib/libbsp/arm/realview-pbx-a9/include/irq.h
index b065c364dd..eb6ce46965 100644
--- a/c/src/lib/libbsp/arm/realview-pbx-a9/include/irq.h
+++ b/c/src/lib/libbsp/arm/realview-pbx-a9/include/irq.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup realview-pbx-a9_interrupt
+ *
+ * @brief Interrupt definitions.
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *
@@ -23,6 +31,14 @@
 #include <bsp/arm-a9mpcore-irq.h>
 #include <bsp/arm-gic-irq.h>
 
+/**
+ * @defgroup realview-pbx-a9_interrupt Interrrupt Support
+ *
+ * @ingroup arm_realview-pbx-a9
+ *
+ * @brief Interrupt support.
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif /* __cplusplus */
diff --git a/c/src/lib/libbsp/arm/realview-pbx-a9/include/tm27.h b/c/src/lib/libbsp/arm/realview-pbx-a9/include/tm27.h
index 96ab469033..f1fcf11565 100644
--- a/c/src/lib/libbsp/arm/realview-pbx-a9/include/tm27.h
+++ b/c/src/lib/libbsp/arm/realview-pbx-a9/include/tm27.h
@@ -1,3 +1,20 @@
+/**
+ * @file
+ *
+ * @ingroup realview-pbx-a9_tm27
+ *
+ * @brief GIC tmtests/tm27 support.
+ */
+
+
+/**
+ * @defgroup realview-pbx-a9_tm27 GIC tmtests/tm27
+ *
+ * @ingroup arm_realview-pbx-a9
+ *
+ * @brief GIC tmtests/tm27 support.
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *
-- 
1.8.4.2




More information about the devel mailing list