[rtems commit] gen68340: Add doxygen header files.

Jennifer Averett jennifer at rtems.org
Thu Jan 2 15:34:35 UTC 2014


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

Author:    Toma Radu <radustoma at yahoo.com>
Date:      Thu Jan  2 09:40:06 2014 -0600

gen68340: Add doxygen header files.

---

 c/src/lib/libbsp/m68k/gen68340/include/bsp.h       |   16 ++++++++++++++++
 c/src/lib/libbsp/m68k/gen68340/include/coverhd.h   |    8 ++++++++
 c/src/lib/libbsp/m68k/gen68340/include/m340timer.h |    8 ++++++++
 c/src/lib/libbsp/m68k/gen68340/include/m340uart.h  |    8 ++++++++
 c/src/lib/libbsp/m68k/gen68340/include/m68340.h    |    8 ++++++++
 5 files changed, 48 insertions(+), 0 deletions(-)

diff --git a/c/src/lib/libbsp/m68k/gen68340/include/bsp.h b/c/src/lib/libbsp/m68k/gen68340/include/bsp.h
index bc5142c..6726533 100644
--- a/c/src/lib/libbsp/m68k/gen68340/include/bsp.h
+++ b/c/src/lib/libbsp/m68k/gen68340/include/bsp.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup m68k_gen68340
+ *
+ * @brief Global BSP definitions.
+ */
+
 /*
  * Board Support Package for `Generic' Motorola MC68340
  *
@@ -30,6 +38,14 @@ extern "C" {
 #include <rtems/iosupp.h>
 #include <rtems/clockdrv.h>
 
+/**
+ * @defgroup m68k_gen68340 Motorola MC68340 Support
+ *
+ * @ingroup bsp_m68k
+ *
+ * @brief Motorola MC68340 support.
+ */
+
 /*
  *  Simple spin delay in microsecond units for device drivers.
  *  This is very dependent on the clock speed of the target.
diff --git a/c/src/lib/libbsp/m68k/gen68340/include/coverhd.h b/c/src/lib/libbsp/m68k/gen68340/include/coverhd.h
index ed1828a..9e8796b 100644
--- a/c/src/lib/libbsp/m68k/gen68340/include/coverhd.h
+++ b/c/src/lib/libbsp/m68k/gen68340/include/coverhd.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup m68k_gen68340
+ *
+ * @brief C overhead definitions.
+ */
+
 /*
  * This file was machine-generated from the tmoverhd.exe output
  */
diff --git a/c/src/lib/libbsp/m68k/gen68340/include/m340timer.h b/c/src/lib/libbsp/m68k/gen68340/include/m340timer.h
index a71ed8c..1ce21d5 100644
--- a/c/src/lib/libbsp/m68k/gen68340/include/m340timer.h
+++ b/c/src/lib/libbsp/m68k/gen68340/include/m340timer.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup m68k_gen68340
+ *
+ * @brief Time driver definitions.
+ */
+
 /*
  *  Header file for timer driver
  *  defines for accessing M68340 timer registers
diff --git a/c/src/lib/libbsp/m68k/gen68340/include/m340uart.h b/c/src/lib/libbsp/m68k/gen68340/include/m340uart.h
index b81ee62..95e53fe 100644
--- a/c/src/lib/libbsp/m68k/gen68340/include/m340uart.h
+++ b/c/src/lib/libbsp/m68k/gen68340/include/m340uart.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup m68k_gen68340
+ *
+ * @brief UART console driver definitions.
+ */
+
 /*
  *  Header file for console driver
  *  defines for accessing M68340/68349 UART registers
diff --git a/c/src/lib/libbsp/m68k/gen68340/include/m68340.h b/c/src/lib/libbsp/m68k/gen68340/include/m68340.h
index fefb223..37440f3 100644
--- a/c/src/lib/libbsp/m68k/gen68340/include/m68340.h
+++ b/c/src/lib/libbsp/m68k/gen68340/include/m68340.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup m68k_gen68340
+ *
+ * @brief MC68430 definitions.
+ */ 
+
 /**********************************************************************
  *  MC68340 C Header File                                             *
  *                                                                    *




More information about the vc mailing list