diff options
author | Szkocsovszki Zsolt <zsoltisharkboy@gmail.com> | 2013-12-26 12:51:20 -0600 |
---|---|---|
committer | Jennifer Averett <jennifer.averett@oarcorp.com> | 2013-12-26 12:51:20 -0600 |
commit | 9bb28849c456562a2721eee7218f17dd814e2a9e (patch) | |
tree | aba7d99e37b7e59b551cc393785d0987d39d8f17 /c/src/lib/libbsp/m68k/shared | |
parent | psx03: Add doc file (diff) | |
download | rtems-9bb28849c456562a2721eee7218f17dd814e2a9e.tar.bz2 |
libbsp/m68k: Add doxygen to m68k shared files.
Diffstat (limited to 'c/src/lib/libbsp/m68k/shared')
-rw-r--r-- | c/src/lib/libbsp/m68k/shared/doxygen.h | 15 | ||||
-rw-r--r-- | c/src/lib/libbsp/m68k/shared/gdbstub/gdb_if.h | 18 | ||||
-rw-r--r-- | 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 0000000000..0877c51e77 --- /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 c3a34e1418..6c68703b76 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 eb564b035a..23f3fb554a 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; |