[rtems commit] lm32_milkymist: improve doxygen
Gedare Bloom
gedare at rtems.org
Tue Dec 24 21:59:42 UTC 2013
Module: rtems
Branch: master
Commit: 03d184d0f80db31e1e0be9e9476d27f9ab204323
Changeset: http://git.rtems.org/rtems/commit/?id=03d184d0f80db31e1e0be9e9476d27f9ab204323
Author: Toma <radustoma at yahoo.com>
Date: Tue Dec 24 15:58:18 2013 -0600
lm32_milkymist: improve doxygen
Add doxygen to the header files in the /lm32/milymist/include directory.
---
c/src/lib/libbsp/lm32/milkymist/include/bsp.h | 16 ++++++++++++++++
.../libbsp/lm32/milkymist/include/system_conf.h | 8 ++++++++
2 files changed, 24 insertions(+), 0 deletions(-)
diff --git a/c/src/lib/libbsp/lm32/milkymist/include/bsp.h b/c/src/lib/libbsp/lm32/milkymist/include/bsp.h
index 99fba5d..fde3618 100644
--- a/c/src/lib/libbsp/lm32/milkymist/include/bsp.h
+++ b/c/src/lib/libbsp/lm32/milkymist/include/bsp.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup lm32_milkymist
+ *
+ * @brief Global BSP definitions.
+ */
+
/* bsp.h
*
* This include file contains all board IO definitions.
@@ -20,6 +28,14 @@
#include <rtems/console.h>
#include <rtems/clockdrv.h>
+/**
+ * @defgroup lm32_milkymist Milkymist Support
+ *
+ * @ingroup bsp_lm32
+ *
+ * @brief Milkymist support package.
+ */
+
#ifdef __cplusplus
extern "C" {
#endif
diff --git a/c/src/lib/libbsp/lm32/milkymist/include/system_conf.h b/c/src/lib/libbsp/lm32/milkymist/include/system_conf.h
index 3172db9..acde18e 100644
--- a/c/src/lib/libbsp/lm32/milkymist/include/system_conf.h
+++ b/c/src/lib/libbsp/lm32/milkymist/include/system_conf.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup lm32_milkymist
+ *
+ * @brief System configuration.
+ */
+
/* system_conf.h
* Global System conf
*
More information about the vc
mailing list