[rtems commit] leon3: improve doxygen

Gedare Bloom gedare at rtems.org
Wed Dec 4 20:23:56 UTC 2013


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

Author:    Toma Radu <radustoma at yahoo.com>
Date:      Wed Dec  4 12:07:04 2013 -0600

leon3: improve doxygen

Add doxygen to the bsp.h, tm27.h, amba.h and leon.h files

---

 c/src/lib/libbsp/sparc/leon3/include/amba.h |    7 +++++++
 c/src/lib/libbsp/sparc/leon3/include/bsp.h  |    5 ++++-
 c/src/lib/libbsp/sparc/leon3/include/leon.h |    6 ++++++
 c/src/lib/libbsp/sparc/leon3/include/tm27.h |    6 ++++++
 4 files changed, 23 insertions(+), 1 deletions(-)

diff --git a/c/src/lib/libbsp/sparc/leon3/include/amba.h b/c/src/lib/libbsp/sparc/leon3/include/amba.h
index cb45e58..3c726b2 100644
--- a/c/src/lib/libbsp/sparc/leon3/include/amba.h
+++ b/c/src/lib/libbsp/sparc/leon3/include/amba.h
@@ -1,3 +1,10 @@
+/**
+ * @file
+ * @defgroup amba AMBA Driver Handler
+ * @ingroup sparc_leon3
+ * @brief AMBA Plag & Play Bus Driver Macros
+ */
+
 /*
  *  AMBA Plag & Play Bus Driver Macros
  *
diff --git a/c/src/lib/libbsp/sparc/leon3/include/bsp.h b/c/src/lib/libbsp/sparc/leon3/include/bsp.h
index 4f4c22b..9aeafa3 100644
--- a/c/src/lib/libbsp/sparc/leon3/include/bsp.h
+++ b/c/src/lib/libbsp/sparc/leon3/include/bsp.h
@@ -1,5 +1,8 @@
 /**
- * @defgroup sparc_leon3 Sparc Leon3 Handler
+ * @file
+ * @defgroup sparc_leon3 Sparc LEON3 Handler
+ * @ingroup bsp_kit
+ * @brief Handles Sparc LEON3 simulator
  */
 
 /*  bsp.h
diff --git a/c/src/lib/libbsp/sparc/leon3/include/leon.h b/c/src/lib/libbsp/sparc/leon3/include/leon.h
index 42c47d6..21a46a8 100644
--- a/c/src/lib/libbsp/sparc/leon3/include/leon.h
+++ b/c/src/lib/libbsp/sparc/leon3/include/leon.h
@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup sparc_leon3
+ * @brief LEON3 BSP data types and macros
+ */
+
 /*  leon.h
  *
  *  LEON3 BSP data types and macros.
diff --git a/c/src/lib/libbsp/sparc/leon3/include/tm27.h b/c/src/lib/libbsp/sparc/leon3/include/tm27.h
index 8e8e43c..a994f83 100644
--- a/c/src/lib/libbsp/sparc/leon3/include/tm27.h
+++ b/c/src/lib/libbsp/sparc/leon3/include/tm27.h
@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup sparc_leon3
+ * @brief Implementations for interrupt mechanisms for Time Test 27
+ */
+
 /*
  *  tm27.h
  *




More information about the vc mailing list