[rtems commit] genmcf548x: Improve Doxygen
Joel Sherrill
joel at rtems.org
Wed Jan 8 21:25:41 UTC 2014
Module: rtems
Branch: master
Commit: d49609536696fa79056a03293ce94b9da574bcf0
Changeset: http://git.rtems.org/rtems/commit/?id=d49609536696fa79056a03293ce94b9da574bcf0
Author: Toma Radu <radustoma at yahoo.com>
Date: Thu Jan 2 11:43:18 2014 -0600
genmcf548x: Improve Doxygen
Add doxygen to the header files in the genmcf548x/include directory.
---
c/src/lib/libbsp/m68k/genmcf548x/include/bsp.h | 16 ++++++++++++++++
c/src/lib/libbsp/m68k/genmcf548x/include/irq.h | 17 +++++++++++++++++
c/src/lib/libbsp/m68k/genmcf548x/include/tm27.h | 8 ++++++++
3 files changed, 41 insertions(+), 0 deletions(-)
diff --git a/c/src/lib/libbsp/m68k/genmcf548x/include/bsp.h b/c/src/lib/libbsp/m68k/genmcf548x/include/bsp.h
index 5d8ba6f..68394a1 100644
--- a/c/src/lib/libbsp/m68k/genmcf548x/include/bsp.h
+++ b/c/src/lib/libbsp/m68k/genmcf548x/include/bsp.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup m68k_genmcf548x
+ *
+ * @brief Global BSP definitions.
+ */
+
/*===============================================================*\
| Project: RTEMS generic mcf548x BSP |
+-----------------------------------------------------------------+
@@ -52,6 +60,14 @@ extern "C" {
#include <bspopts.h>
#include <bsp/default-initial-extension.h>
+/**
+ * @defgroup m68k_genmcf548x MCF548X Support
+ *
+ * @ingroup bsp_m68k
+ *
+ * @brief MCT548X support.
+ */
+
#include <rtems.h>
#include <rtems/iosupp.h>
#include <rtems/console.h>
diff --git a/c/src/lib/libbsp/m68k/genmcf548x/include/irq.h b/c/src/lib/libbsp/m68k/genmcf548x/include/irq.h
index 23ff73d..8d58fc6 100644
--- a/c/src/lib/libbsp/m68k/genmcf548x/include/irq.h
+++ b/c/src/lib/libbsp/m68k/genmcf548x/include/irq.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup genmcf548x_interrupt
+ *
+ * @brief Interrupt definitions.
+ */
+
/*
* Copyright (c) 2013 embedded brains GmbH. All rights reserved.
*
@@ -19,6 +27,15 @@
#include <rtems/irq.h>
#include <rtems/irq-extension.h>
+/**
+ * @defgroup genmcf548x_interrupt Interrupt Support
+ *
+ * @ingroup m68k_genmcf548x
+ *
+ * @brief Interrupt support.
+ */
+
+
#define MCF548X_IRQ_EPORT_EPF1 1
#define MCF548X_IRQ_EPORT_EPF2 2
#define MCF548X_IRQ_EPORT_EPF3 3
diff --git a/c/src/lib/libbsp/m68k/genmcf548x/include/tm27.h b/c/src/lib/libbsp/m68k/genmcf548x/include/tm27.h
index f8fe447..628df98 100644
--- a/c/src/lib/libbsp/m68k/genmcf548x/include/tm27.h
+++ b/c/src/lib/libbsp/m68k/genmcf548x/include/tm27.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup m68k_genmcf548x
+ *
+ * @brief Time Test 27 routines.
+ */
+
/*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
More information about the vc
mailing list