[rtems commit] arm: realview-pbx-a9: Add doxygen

Gedare Bloom gedare at rtems.org
Sat Dec 14 02:32:04 UTC 2013


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

Author:    Chirayu Desai <cdesai at cyanogenmod.org>
Date:      Fri Dec 13 21:50:29 2013 +0530

arm: realview-pbx-a9: Add doxygen

---

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

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 05c0fd0..c4f14d4 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 b065c36..eb6ce46 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 96ab469..f1fcf11 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.
  *




More information about the vc mailing list