[rtems commit] libbsp/m68k: Add doxygen to m68k shared files.

Jennifer Averett jennifer at rtems.org
Thu Dec 26 18:45:53 UTC 2013


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

Author:    Szkocsovszki Zsolt <zsoltisharkboy at gmail.com>
Date:      Thu Dec 26 12:51:20 2013 -0600

libbsp/m68k: Add doxygen to m68k shared files.

---

 c/src/lib/libbsp/m68k/shared/doxygen.h         |   15 +++++++++++++++
 c/src/lib/libbsp/m68k/shared/gdbstub/gdb_if.h  |   18 ++++++++++++++++--
 c/src/lib/libbsp/m68k/shared/mvme/mvme16x_hw.h |   16 ++++++++++++++--
 3 files changed, 45 insertions(+), 4 deletions(-)

diff --git a/c/src/lib/libbsp/m68k/shared/doxygen.h b/c/src/lib/libbsp/m68k/shared/doxygen.h
new file mode 100644
index 0000000..0877c51
--- /dev/null
+++ b/c/src/lib/libbsp/m68k/shared/doxygen.h
@@ -0,0 +1,15 @@
+/**
+  *  @defgroup bsp_m68k M68K
+  *
+  *  @ingroup bsp_kit
+  *
+  *  @brief M68K Board Support Packages
+  */
+
+/**
+  *  @defgroup m68k_shared M68K Shared Modules
+  *
+  *  @ingroup bsp_m68k
+  *
+  *  @brief M68K Shared Modules
+  */
\ No newline at end of file
diff --git a/c/src/lib/libbsp/m68k/shared/gdbstub/gdb_if.h b/c/src/lib/libbsp/m68k/shared/gdbstub/gdb_if.h
index c3a34e1..6c68703 100644
--- a/c/src/lib/libbsp/m68k/shared/gdbstub/gdb_if.h
+++ b/c/src/lib/libbsp/m68k/shared/gdbstub/gdb_if.h
@@ -1,6 +1,12 @@
-/*
- * gdb_if.h - definition of the interface between the stub and gdb
+/**
+ *  @file
+ *
+ *  @ingroup m68k_gdbstub
  *
+ *  @brief definition of the interface between the stub and gdb
+ */
+
+/*
  *                   THIS SOFTWARE IS NOT COPYRIGHTED
  *
  *  The following software is offered for use in the public domain.
@@ -15,6 +21,14 @@
 #ifndef _GDB_IF_H
 #define _GDB_IF_H
 
+/**
+ *  @defgroup m68k_gdbstub GDB Stub
+ *
+ *  @ingroup m68k_shared
+ *
+ *  @brief GDB Stub interface support
+ */
+
 /* Max number of threads in qM response */
 #define QM_MAX_THREADS (20)
 
diff --git a/c/src/lib/libbsp/m68k/shared/mvme/mvme16x_hw.h b/c/src/lib/libbsp/m68k/shared/mvme/mvme16x_hw.h
index eb564b0..23f3fb5 100644
--- a/c/src/lib/libbsp/m68k/shared/mvme/mvme16x_hw.h
+++ b/c/src/lib/libbsp/m68k/shared/mvme/mvme16x_hw.h
@@ -1,3 +1,11 @@
+/**
+ *  @file
+ *
+ *  @ingroup m68k_mvme
+ *
+ *  @brief MVME16x IO definitions
+ */
+
 /*  mvme16x_hw.h
  *
  *  This include file contains all MVME16x board IO definitions
@@ -21,8 +29,12 @@
 extern "C" {
 #endif
 
-/*
- * Network driver configuration
+/**
+ *  @defgroup m68k_mvme MVME16X IO Support
+ *
+ *  @ingroup m68k_shared
+ *
+ *  @brief IO Support Package
  */
 
 struct rtems_bsdnet_ifconfig;




More information about the vc mailing list