[rtems commit] lm32_evr: improve doxygen

Gedare Bloom gedare at rtems.org
Tue Dec 24 19:30:46 UTC 2013


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

Author:    Toma <radustoma at yahoo.com>
Date:      Tue Dec 24 13:13:13 2013 -0600

lm32_evr: improve doxygen

Add doxygen to the header files in the /lm32/lm32_evr/include directory.

---

 c/src/lib/libbsp/lm32/lm32_evr/include/bsp.h       |   16 ++++++++++++++++
 c/src/lib/libbsp/lm32/lm32_evr/include/coverhd.h   |    8 ++++++++
 .../lib/libbsp/lm32/lm32_evr/include/system_conf.h |    8 ++++++++
 c/src/lib/libbsp/lm32/lm32_evr/include/tm27.h      |    8 ++++++++
 4 files changed, 40 insertions(+), 0 deletions(-)

diff --git a/c/src/lib/libbsp/lm32/lm32_evr/include/bsp.h b/c/src/lib/libbsp/lm32/lm32_evr/include/bsp.h
index db66c4f..7a532a7 100644
--- a/c/src/lib/libbsp/lm32/lm32_evr/include/bsp.h
+++ b/c/src/lib/libbsp/lm32/lm32_evr/include/bsp.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup lm32_evr
+ *
+ * @brief Global BSP definitions.
+ */
+
 /*  bsp.h
  *
  *  This include file contains all board IO definitions.
@@ -26,6 +34,14 @@
 #include <rtems/console.h>
 #include <rtems/clockdrv.h>
 
+/**
+ * @defgroup lm32_evr EVR Support
+ *
+ * @ingroup bsp_lm32
+ *
+ * @brief EVR support package.
+ */
+
 #if defined(RTEMS_NETWORKING)
 #include <rtems/rtems_bsdnet.h>
 #endif
diff --git a/c/src/lib/libbsp/lm32/lm32_evr/include/coverhd.h b/c/src/lib/libbsp/lm32/lm32_evr/include/coverhd.h
index b418393..ea0a13a 100644
--- a/c/src/lib/libbsp/lm32/lm32_evr/include/coverhd.h
+++ b/c/src/lib/libbsp/lm32/lm32_evr/include/coverhd.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ * 
+ * @ingroup lm32_evr
+ *
+ * @brief C overhead definitions.
+ */
+
 /*  coverhd.h
  *
  *  This include file has defines to represent the overhead associated
diff --git a/c/src/lib/libbsp/lm32/lm32_evr/include/system_conf.h b/c/src/lib/libbsp/lm32/lm32_evr/include/system_conf.h
index fe3f46f..41f17e2 100644
--- a/c/src/lib/libbsp/lm32/lm32_evr/include/system_conf.h
+++ b/c/src/lib/libbsp/lm32/lm32_evr/include/system_conf.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ * 
+ * @ingroup lm32_evr
+ * 
+ * @brief System configuration.
+ */
+
 #ifndef __SYSTEM_CONFIG_H_
 #define __SYSTEM_CONFIG_H_
 
diff --git a/c/src/lib/libbsp/lm32/lm32_evr/include/tm27.h b/c/src/lib/libbsp/lm32/lm32_evr/include/tm27.h
index b94582d..7a3c964 100644
--- a/c/src/lib/libbsp/lm32/lm32_evr/include/tm27.h
+++ b/c/src/lib/libbsp/lm32/lm32_evr/include/tm27.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ * 
+ * @ingroup lm32_evr
+ * 
+ * @brief TM27 timing test routines.
+ */
+
 /*
  *  tm27.h
  *




More information about the vc mailing list