[rtems commit] arm: gdbarmsim: Add doxygen

Gedare Bloom gedare at rtems.org
Sun Dec 8 02:21:27 UTC 2013


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

Author:    Chirayu Desai <cdesai at cyanogenmod.org>
Date:      Sat Dec  7 19:52:07 2013 +0530

arm: gdbarmsim: Add doxygen

---

 c/src/lib/libbsp/arm/gdbarmsim/include/bsp.h |   24 +++++++++++++++++++++++-
 c/src/lib/libbsp/arm/gdbarmsim/include/swi.h |    8 ++++++++
 2 files changed, 31 insertions(+), 1 deletions(-)

diff --git a/c/src/lib/libbsp/arm/gdbarmsim/include/bsp.h b/c/src/lib/libbsp/arm/gdbarmsim/include/bsp.h
index 2a7917c..f9975f9 100644
--- a/c/src/lib/libbsp/arm/gdbarmsim/include/bsp.h
+++ b/c/src/lib/libbsp/arm/gdbarmsim/include/bsp.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup arm_gdbarmsim
+ *
+ * @brief Global BSP definitions.
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2009.
  *  On-Line Applications Research Corporation (OAR).
@@ -22,10 +30,24 @@ extern "C" {
 #include <rtems/console.h>
 #include <rtems/clockdrv.h>
 
-/* support for simulated clock tick */
+/**
+ * @defgroup arm_gdbarmsim GDBARMSIM Support
+ *
+ * @ingroup bsp_arm
+ *
+ * @brief GDBARMSIM support package.
+ *
+ * @{
+ */
+
+/**
+ * @brief Support for simulated clock tick
+ */
 Thread clock_driver_sim_idle_body(uintptr_t);
 #define BSP_IDLE_TASK_BODY clock_driver_sim_idle_body
 
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/c/src/lib/libbsp/arm/gdbarmsim/include/swi.h b/c/src/lib/libbsp/arm/gdbarmsim/include/swi.h
index af46ada..3051232 100644
--- a/c/src/lib/libbsp/arm/gdbarmsim/include/swi.h
+++ b/c/src/lib/libbsp/arm/gdbarmsim/include/swi.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup arm_gdbarmsim
+ *
+ * @brief Software interrupt definitions.
+ */
+
 /*
  *  Copied from libgloss 1 Oct 2009.
  *  Minor modifications to work with RTEMS.




More information about the vc mailing list