[rtems commit] m32rsim: Add doxygen headers.

Jennifer Averett jennifer at rtems.org
Mon Dec 30 20:01:39 UTC 2013


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

Author:    Szkocsovszki Zsolt <zsoltisharkboy at gmail.com>
Date:      Mon Dec 30 14:07:13 2013 -0600

m32rsim: Add doxygen headers.

---

 c/src/lib/libbsp/m32r/m32rsim/doxygen.h      |   15 +++++++++++++++
 c/src/lib/libbsp/m32r/m32rsim/include/bsp.h  |   17 ++++++++++++++++-
 c/src/lib/libbsp/m32r/m32rsim/include/tm27.h |   16 ++++++++++++++--
 3 files changed, 45 insertions(+), 3 deletions(-)

diff --git a/c/src/lib/libbsp/m32r/m32rsim/doxygen.h b/c/src/lib/libbsp/m32r/m32rsim/doxygen.h
new file mode 100644
index 0000000..c4dc5e8
--- /dev/null
+++ b/c/src/lib/libbsp/m32r/m32rsim/doxygen.h
@@ -0,0 +1,15 @@
+/**
+ *  @defgroup bsp_m32r M32R
+ *
+ *  @ingroup bsp_kit
+ *
+ *  @brief M32R Board Support Packages
+ */
+
+/**
+ *  @defgroup m32r_m32rsim M32R M32RSIM Modules
+ *
+ *  @ingroup bsp_m32r
+ *
+ *  @brief M32R M32RSIM Modules
+ */
\ No newline at end of file
diff --git a/c/src/lib/libbsp/m32r/m32rsim/include/bsp.h b/c/src/lib/libbsp/m32r/m32rsim/include/bsp.h
index 708f100..d108ad5 100644
--- a/c/src/lib/libbsp/m32r/m32rsim/include/bsp.h
+++ b/c/src/lib/libbsp/m32r/m32rsim/include/bsp.h
@@ -1,3 +1,11 @@
+/**
+ *  @file
+ *
+ *  @ingroup m32r_bsp
+ *
+ *  @brief m32r definitions in gdb
+ */
+
 /*  bsp.h
  *
  *  This include file contains some definitions specific to the
@@ -26,7 +34,14 @@ extern "C" {
 #include <rtems/console.h>
 #include <rtems/clockdrv.h>
 
-/* support for simulated clock tick */
+/**
+ *  @defgroup m32r_bsp Clock Tick Support
+ *
+ *  @ingroup m32r_m32rsim
+ *
+ *  @brief Clock Tick Support Package
+ */
+
 Thread clock_driver_sim_idle_body(uintptr_t);
 #define BSP_IDLE_TASK_BODY clock_driver_sim_idle_body
 
diff --git a/c/src/lib/libbsp/m32r/m32rsim/include/tm27.h b/c/src/lib/libbsp/m32r/m32rsim/include/tm27.h
index 34fb939..ddf77c2 100644
--- a/c/src/lib/libbsp/m32r/m32rsim/include/tm27.h
+++ b/c/src/lib/libbsp/m32r/m32rsim/include/tm27.h
@@ -1,3 +1,11 @@
+/**
+ *  @file
+ *
+ *  @ingroup m32r_tm27
+ *
+ *  @brief Time Test 27
+ */
+
 /*
  *  tm27.h
  *
@@ -13,8 +21,12 @@
 #ifndef __tm27_h
 #define __tm27_h
 
-/*
- *  Define the interrupt mechanism for Time Test 27
+/**
+ *  @defgroup m32r_tm27 Time Test 27
+ *
+ *  @ingroup m32r_m32rsim
+ *
+ *  @brief Define the interrupt mechanism for Time Test 27
  */
 
 #define MUST_WAIT_FOR_INTERRUPT 0




More information about the vc mailing list