[rtems commit] erc32: improve doxygen

Gedare Bloom gedare at rtems.org
Wed Dec 4 21:17:05 UTC 2013


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

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

erc32: improve doxygen

Add doxygen to the bsp.h, tm27.h, erc32.h and irq.h files.

---

 c/src/lib/libbsp/sparc/erc32/include/bsp.h     |    7 +++++++
 c/src/lib/libbsp/sparc/erc32/include/bsp/irq.h |    6 ++++++
 c/src/lib/libbsp/sparc/erc32/include/erc32.h   |    6 ++++++
 c/src/lib/libbsp/sparc/erc32/include/tm27.h    |    6 ++++++
 4 files changed, 25 insertions(+), 0 deletions(-)

diff --git a/c/src/lib/libbsp/sparc/erc32/include/bsp.h b/c/src/lib/libbsp/sparc/erc32/include/bsp.h
index 955671a..2045867 100644
--- a/c/src/lib/libbsp/sparc/erc32/include/bsp.h
+++ b/c/src/lib/libbsp/sparc/erc32/include/bsp.h
@@ -1,3 +1,10 @@
+/**
+ * @file
+ * @defgroup sparc_erc32 SPARC ERC32
+ * @ingroup bsp_kit
+ * @brief SPARC ERC32 BSP
+ */
+
 /*  bsp.h
  *
  *  This include file contains all SPARC simulator definitions.
diff --git a/c/src/lib/libbsp/sparc/erc32/include/bsp/irq.h b/c/src/lib/libbsp/sparc/erc32/include/bsp/irq.h
index c0e931b..e496239 100644
--- a/c/src/lib/libbsp/sparc/erc32/include/bsp/irq.h
+++ b/c/src/lib/libbsp/sparc/erc32/include/bsp/irq.h
@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup sparc_erc32
+ * @brief ERC32 generic shared IRQ setup
+ */
+
 /* ERC32 generic shared IRQ setup
  *
  * Based on libbsp/shared/include/irq.h.
diff --git a/c/src/lib/libbsp/sparc/erc32/include/erc32.h b/c/src/lib/libbsp/sparc/erc32/include/erc32.h
index 41e7360..bea543c 100644
--- a/c/src/lib/libbsp/sparc/erc32/include/erc32.h
+++ b/c/src/lib/libbsp/sparc/erc32/include/erc32.h
@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup sparc_erc32
+ * @brief Contains information pertaining to the ERC32
+ */
+
 /*  erc32.h
  *
  *  This include file contains information pertaining to the ERC32.
diff --git a/c/src/lib/libbsp/sparc/erc32/include/tm27.h b/c/src/lib/libbsp/sparc/erc32/include/tm27.h
index cfd6a16..5b1112b 100644
--- a/c/src/lib/libbsp/sparc/erc32/include/tm27.h
+++ b/c/src/lib/libbsp/sparc/erc32/include/tm27.h
@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup sparc_erc32
+ * @brief Implementations for interrupt mechanisms for Time Test 27
+ */
+
 /*
  *  tm27.h
  *




More information about the vc mailing list