[rtems commit] idp: Add doxygen headers.
Jennifer Averett
jennifer at rtems.org
Fri Jan 3 14:09:44 UTC 2014
Module: rtems
Branch: master
Commit: 6b1ee0258ebbec56e3f7ccda612b834a00265c83
Changeset: http://git.rtems.org/rtems/commit/?id=6b1ee0258ebbec56e3f7ccda612b834a00265c83
Author: Szkocsovszki Zsolt <zsoltisharkboy at gmail.com>
Date: Fri Jan 3 08:14:49 2014 -0600
idp: Add doxygen headers.
---
c/src/lib/libbsp/m68k/idp/doxygen.h | 15 +++++++++++++++
c/src/lib/libbsp/m68k/idp/include/bsp.h | 16 ++++++++++++++--
c/src/lib/libbsp/m68k/idp/include/leds.h | 19 +++++++++++++++++--
3 files changed, 46 insertions(+), 4 deletions(-)
diff --git a/c/src/lib/libbsp/m68k/idp/doxygen.h b/c/src/lib/libbsp/m68k/idp/doxygen.h
new file mode 100644
index 0000000..3c507b7
--- /dev/null
+++ b/c/src/lib/libbsp/m68k/idp/doxygen.h
@@ -0,0 +1,15 @@
+/**
+ * @defgroup bsp_m68k M68K
+ *
+ * @ingroup bsp_kit
+ *
+ * @brief M68K Board Support Packages
+ */
+
+/**
+ * @defgroup m68k_idp M68K IDP Modules
+ *
+ * @ingroup bsp_m68k
+ *
+ * @brief M68K IDP Modules
+ */
\ No newline at end of file
diff --git a/c/src/lib/libbsp/m68k/idp/include/bsp.h b/c/src/lib/libbsp/m68k/idp/include/bsp.h
index 599bf1f..39d8c41 100644
--- a/c/src/lib/libbsp/m68k/idp/include/bsp.h
+++ b/c/src/lib/libbsp/m68k/idp/include/bsp.h
@@ -1,6 +1,10 @@
-/* bsp.h
+/**
+ * @file
*
- * This include file contains all Motorola 680x0 IDP board IO definitions.
+ * @ingroup idp_bsp
+ *
+ * @brief This include file contains all Motorola 680x0 IDP board
+ * IO definitions.
*/
#ifndef _BSP_H
@@ -15,6 +19,14 @@
#include <rtems/motorola/mc68230.h>
#include <rtems/motorola/mc68681.h>
+/**
+ * @defgroup idp_bsp IO definitions
+ *
+ * @ingroup m68k_idp
+ *
+ * @brief Motorola 680x0 IDP board IO definitions
+ */
+
#define DUART_ADDR 0xb00003 /* base address of the MC68681 DUART */
/* Constants */
diff --git a/c/src/lib/libbsp/m68k/idp/include/leds.h b/c/src/lib/libbsp/m68k/idp/include/leds.h
index 79df848..4c0313c 100644
--- a/c/src/lib/libbsp/m68k/idp/include/leds.h
+++ b/c/src/lib/libbsp/m68k/idp/include/leds.h
@@ -1,6 +1,13 @@
+/**
+ * @file
+ *
+ * @ingroup m68k_leds
+ *
+ * @brief Led Control
+ */
+
/*
- * leds.c -- control the led's on a Motorola mc68ec0x0 board.
- * Written by rob at cygnus.com (Rob Savoye)
+ * Written by rob at cygnus.com (Rob Savoye)
*/
#ifndef __LEDS_H__
@@ -18,6 +25,14 @@
#define LEDS_OFF 0xff
#define LEDS_ON 0x0
+/**
+ * @defgroup m68k_leds Led Control
+ *
+ * @ingroup m68k_idp
+ *
+ * @brief control the led's on a Motorola mc68ec0x0 board
+ */
+
#define FUDGE(x) ((x >= 0xa && x <= 0xf) ? (x + 'a') & 0x7f : (x + '0') & 0x7f)
extern void led_putnum( char );
More information about the vc
mailing list