summaryrefslogtreecommitdiffstats
path: root/c/src/lib/libbsp/m68k/gen68360
diff options
context:
space:
mode:
authorSzkocsovszki Zsolt <zsoltisharkboy@gmail.com>2014-01-01 22:30:24 +0100
committerJoel Sherrill <joel.sherrill@oarcorp.com>2014-01-08 15:24:09 -0600
commitd48ac1814446d71e567d4d6c44bda39a753f5e55 (patch)
treea7db4800f31608afeb021524616baa901f0be002 /c/src/lib/libbsp/m68k/gen68360
parentsp16, sp17, and sp20: Documentation Fixes (diff)
downloadrtems-d48ac1814446d71e567d4d6c44bda39a753f5e55.tar.bz2
m68k/gen68360: Improve Doxygen
Diffstat (limited to 'c/src/lib/libbsp/m68k/gen68360')
-rw-r--r--c/src/lib/libbsp/m68k/gen68360/doxygen.h15
-rw-r--r--c/src/lib/libbsp/m68k/gen68360/include/bsp.h18
-rw-r--r--c/src/lib/libbsp/m68k/gen68360/include/coverhd.h9
-rw-r--r--c/src/lib/libbsp/m68k/gen68360/include/tm27.h18
-rw-r--r--c/src/lib/libbsp/m68k/gen68360/spi/m360_spi.h19
5 files changed, 68 insertions, 11 deletions
diff --git a/c/src/lib/libbsp/m68k/gen68360/doxygen.h b/c/src/lib/libbsp/m68k/gen68360/doxygen.h
new file mode 100644
index 0000000000..2a692d28f0
--- /dev/null
+++ b/c/src/lib/libbsp/m68k/gen68360/doxygen.h
@@ -0,0 +1,15 @@
+/**
+ * @defgroup bsp_m68k M68K
+ *
+ * @ingroup bsp_kit
+ *
+ * @brief M68K Board Support Packages
+ */
+
+/**
+ * @defgroup m68k_gen68360 M68K GEN68360 Modules
+ *
+ * @ingroup bsp_m68k
+ *
+ * @brief M68K GEN68360 Modules
+ */ \ No newline at end of file
diff --git a/c/src/lib/libbsp/m68k/gen68360/include/bsp.h b/c/src/lib/libbsp/m68k/gen68360/include/bsp.h
index 383946f1ef..ed05ade80f 100644
--- a/c/src/lib/libbsp/m68k/gen68360/include/bsp.h
+++ b/c/src/lib/libbsp/m68k/gen68360/include/bsp.h
@@ -1,5 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup gen68360_bsp
+ *
+ * @brief Board Support Package for `Generic' Motorola MC68360
+ */
+
/*
- * Board Support Package for `Generic' Motorola MC68360
*
* Based on the `gen68302' board support package, and covered by the
* original distribution terms.
@@ -36,9 +43,14 @@ extern "C" {
#include <rtems/iosupp.h>
#include <rtems/clockdrv.h>
-/*
- * Network driver configuration
+/**
+ * @defgroup gen68360_bsp Network driver
+ *
+ * @ingroup m68k_gen68360
+ *
+ * @brief Network driver configuration
*/
+
struct rtems_bsdnet_ifconfig;
extern int rtems_scc1_driver_attach (struct rtems_bsdnet_ifconfig *config, int attaching);
#define RTEMS_BSP_NETWORK_DRIVER_NAME "scc1"
diff --git a/c/src/lib/libbsp/m68k/gen68360/include/coverhd.h b/c/src/lib/libbsp/m68k/gen68360/include/coverhd.h
index b7fc6e5ce1..c199d6212c 100644
--- a/c/src/lib/libbsp/m68k/gen68360/include/coverhd.h
+++ b/c/src/lib/libbsp/m68k/gen68360/include/coverhd.h
@@ -1,6 +1,11 @@
-/*
- * This file was machine-generated from the tmoverhd.exe output
+/**
+ * @file
+ *
+ * @ingroup m68k_coverhd
+ *
+ * @brief This file was machine-generated from the tmoverhd.exe output
*/
+
#define CALLING_OVERHEAD_INITIALIZE_EXECUTIVE 2
#define CALLING_OVERHEAD_SHUTDOWN_EXECUTIVE 2
#define CALLING_OVERHEAD_TASK_CREATE 4
diff --git a/c/src/lib/libbsp/m68k/gen68360/include/tm27.h b/c/src/lib/libbsp/m68k/gen68360/include/tm27.h
index 6dadf72164..7065550dc9 100644
--- a/c/src/lib/libbsp/m68k/gen68360/include/tm27.h
+++ b/c/src/lib/libbsp/m68k/gen68360/include/tm27.h
@@ -1,4 +1,11 @@
-/*
+/**
+ * @file
+ *
+ * @ingroup m68k_tm27
+ *
+ * @brief Time Test 27
+ */
+
* tm27.h
*
* The license and distribution terms for this file may be
@@ -13,9 +20,12 @@
#ifndef __tm27_h
#define __tm27_h
-/*
- * Stuff for Time Test 27
- * Don't bother with hardware -- just use a software-interrupt
+/**
+ * @defgroup m68k_tm27 Stuff for Time Test 27
+ *
+ * @ingroup m68k_gen68360
+ *
+ * @brief Don't bother with hardware -- just use a software-interrupt
*/
#define MUST_WAIT_FOR_INTERRUPT 0
diff --git a/c/src/lib/libbsp/m68k/gen68360/spi/m360_spi.h b/c/src/lib/libbsp/m68k/gen68360/spi/m360_spi.h
index e46a2afc32..6c6d4f7f32 100644
--- a/c/src/lib/libbsp/m68k/gen68360/spi/m360_spi.h
+++ b/c/src/lib/libbsp/m68k/gen68360/spi/m360_spi.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup m68k_m360spi
+ *
+ * @brief this file contains the MC68360 SPI driver declarations
+ */
+
/*===============================================================*\
| Project: RTEMS support for MC68360 |
+-----------------------------------------------------------------+
@@ -13,9 +21,16 @@
| |
| http://www.rtems.com/license/LICENSE. |
| |
-+-----------------------------------------------------------------+
-| this file contains the MC68360 SPI driver declarations |
\*===============================================================*/
+
+/**
+ * @defgroup m68k_m360spi M360_SPIDRV Support
+ *
+ * @ingroup m68k_gen68360
+ *
+ * @brief M360_SPIDRV Support Package
+ */
+
#ifndef _M360_SPIDRV_H
#define _M360_SPIDRV_H