[rtems commit] h8sim: Add Doxygen directives
Joel Sherrill
joel at rtems.org
Sat Dec 28 23:50:20 UTC 2013
Module: rtems
Branch: master
Commit: d281de9133a27462ae9e1aba21680c3551ed8814
Changeset: http://git.rtems.org/rtems/commit/?id=d281de9133a27462ae9e1aba21680c3551ed8814
Author: Szkocsovszki Zsolt <zsoltisharkboy at gmail.com>
Date: Sat Dec 28 23:32:17 2013 +0100
h8sim: Add Doxygen directives
---
c/src/lib/libbsp/h8300/h8sim/doxygen.h | 15 +++++++++++++++
c/src/lib/libbsp/h8300/h8sim/include/bsp.h | 17 ++++++++++++++++-
2 files changed, 31 insertions(+), 1 deletions(-)
diff --git a/c/src/lib/libbsp/h8300/h8sim/doxygen.h b/c/src/lib/libbsp/h8300/h8sim/doxygen.h
new file mode 100644
index 0000000..b2ced3e
--- /dev/null
+++ b/c/src/lib/libbsp/h8300/h8sim/doxygen.h
@@ -0,0 +1,15 @@
+/**
+ * @defgroup bsp_h8300 H8300
+ *
+ * @ingroup bsp_kit
+ *
+ * @brief H8300 Board Support Packages
+ */
+
+/**
+ * @defgroup h8300_h8sim H8300 H8SIM Modules
+ *
+ * @ingroup bsp_h8300
+ *
+ * @brief H8300 H8SIM Modules
+ */
diff --git a/c/src/lib/libbsp/h8300/h8sim/include/bsp.h b/c/src/lib/libbsp/h8300/h8sim/include/bsp.h
index c2ad183..6a3660e 100644
--- a/c/src/lib/libbsp/h8300/h8sim/include/bsp.h
+++ b/c/src/lib/libbsp/h8300/h8sim/include/bsp.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup h8300_bsp
+ *
+ * @brief h8 simulator 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 h8300_bsp Clock Tick Support
+ *
+ * @ingroup h8300_h8sim
+ *
+ * @brief Clock Tick Support Package
+ */
+
Thread clock_driver_sim_idle_body(uintptr_t);
#define BSP_IDLE_TASK_BODY clock_driver_sim_idle_body
More information about the vc
mailing list