[rtems commit] av5282: Improve Doxygen

Joel Sherrill joel at rtems.org
Wed Jan 8 21:25:41 UTC 2014


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

Author:    Toma Radu <radustoma at yahoo.com>
Date:      Fri Jan  3 14:18:58 2014 -0600

av5282: Improve Doxygen

Add doxygen to the header files in the av5282/include directory.

---

 c/src/lib/libbsp/m68k/av5282/include/bsp.h  |   16 ++++++++++++++++
 c/src/lib/libbsp/m68k/av5282/include/tm27.h |    8 ++++++++
 2 files changed, 24 insertions(+), 0 deletions(-)

diff --git a/c/src/lib/libbsp/m68k/av5282/include/bsp.h b/c/src/lib/libbsp/m68k/av5282/include/bsp.h
index 6af587a..2068bb1 100644
--- a/c/src/lib/libbsp/m68k/av5282/include/bsp.h
+++ b/c/src/lib/libbsp/m68k/av5282/include/bsp.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup m68k_av5282
+ *
+ * @brief Global BSP definitions.
+ */
+
 /*
  *  av5282 BSP header file
  */
@@ -75,3 +83,11 @@ rtems_isr_entry set_vector(
 #endif
 
 #endif
+
+/**
+ * @defgroup m68k_av5282 AV5282 Support
+ *
+ * @ingroup bsp_m68k
+ *
+ * @brief AV5282 support.
+ */
diff --git a/c/src/lib/libbsp/m68k/av5282/include/tm27.h b/c/src/lib/libbsp/m68k/av5282/include/tm27.h
index f8fe447..d26abe7 100644
--- a/c/src/lib/libbsp/m68k/av5282/include/tm27.h
+++ b/c/src/lib/libbsp/m68k/av5282/include/tm27.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup m68k_av5282
+ *
+ * @brief Time Test 27 routines.
+ */
+
 /*
  *  The license and distribution terms for this file may be
  *  found in the file LICENSE in this distribution or at




More information about the vc mailing list