[rtems commit] m68k/idp: Minor Doxygen Cleanup
Joel Sherril
joel at rtems.org
Wed Dec 30 00:35:25 UTC 2015
Module: rtems
Branch: master
Commit: 0c0c18ad6917c9684b4a44cd7f59322f43300518
Changeset: http://git.rtems.org/rtems/commit/?id=0c0c18ad6917c9684b4a44cd7f59322f43300518
Author: Joel Sherrill <joel.sherrill at oarcorp.com>
Date: Wed Dec 23 10:11:07 2015 -0600
m68k/idp: Minor Doxygen Cleanup
---
.../lib/libbsp/m68k/idp/include/motorola/mc68230.h | 21 +++++++++++++++------
.../lib/libbsp/m68k/idp/include/motorola/mc68681.h | 18 +++++++++++++-----
2 files changed, 28 insertions(+), 11 deletions(-)
diff --git a/c/src/lib/libbsp/m68k/idp/include/motorola/mc68230.h b/c/src/lib/libbsp/m68k/idp/include/motorola/mc68230.h
index 2f94e00..6fd4eed 100644
--- a/c/src/lib/libbsp/m68k/idp/include/motorola/mc68230.h
+++ b/c/src/lib/libbsp/m68k/idp/include/motorola/mc68230.h
@@ -1,15 +1,17 @@
/**
- * @file rtems/motorola/mc68230.h
+ * @file rtems/motorola/mc68230.h
*
- * Low level support code for the Motorola 68230 Parallel
- * Interface/Timer (PIT)
+ * @ingroup idp_m68230
+ *
+ * @brief Low level support code for the Motorola 68230 Parallel
+ * Interface/Timer (PIT)
*/
/*
- * Modified by Doug McBride, Colorado Space Grant College
+ * Modified by Doug McBride, Colorado Space Grant College
*
- * Format taken partly from RTEMS code and mostly from Motorola IDP user's
- * manual. RTEMS copyright information below.
+ * Format taken partly from RTEMS code and mostly from Motorola IDP user's
+ * manual. RTEMS copyright information below.
*
* COPYRIGHT (c) 1989-2011.
* On-Line Applications Research Corporation (OAR).
@@ -19,6 +21,13 @@
* http://www.rtems.org/license/LICENSE.
*/
+/**
+ * @defgroup idp_mc68230 Motorola MC68230
+ *
+ * @ingroup m68k_idp
+ *
+ * @brief Support code for Motorola MC68230 PIT
+ */
#ifndef _RTEMS_MOTOROLA_MC68230_H
#define _RTEMS_MOTOROLA_MC68230_H
diff --git a/c/src/lib/libbsp/m68k/idp/include/motorola/mc68681.h b/c/src/lib/libbsp/m68k/idp/include/motorola/mc68681.h
index 83a7d1f..47045c8 100644
--- a/c/src/lib/libbsp/m68k/idp/include/motorola/mc68681.h
+++ b/c/src/lib/libbsp/m68k/idp/include/motorola/mc68681.h
@@ -1,15 +1,23 @@
/**
- * @file rtems/motorola/mc68681.h
+ * @file rtems/motorola/mc68681.h
*
+ * @ingroup idp_mc68681
*
- * mc68681-duart.h -- Low level support code for the Motorola mc68681
- * DUART.
+ * @brief Low level support code for the Motorola mc68681 DUART.
*/
/*
*
* Originally written by rob at cygnus.com (Rob Savoye) for the libgloss
- * IDP support.
+ * IDP support.
+ */
+
+/**
+ * @defgroup idp_mc68681 Motorola MC68681
+ *
+ * @ingroup m68k_idp
+ *
+ * @brief Support code for Motorola MC68681 DUART
*/
#ifndef _RTEMS_MOTOROLA_MC68681_H
@@ -31,7 +39,7 @@
#define __MC68681_REG(_R) ((_R) * MC68681_OFFSET_MULTIPLIER)
/*
- * mc68681 register offsets Read/Write Addresses
+ * mc68681 register offsets Read/Write Addresses
*/
#define MC68681_MODE_REG_1A __MC68681_REG(0) /* MR1A-MR Prior to Read */
#define MC68681_MODE_REG_2A __MC68681_REG(0) /* MR2A-MR After Read */
More information about the vc
mailing list