From d49609536696fa79056a03293ce94b9da574bcf0 Mon Sep 17 00:00:00 2001 From: Toma Radu Date: Thu, 2 Jan 2014 11:43:18 -0600 Subject: [PATCH] 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(+) diff --git a/c/src/lib/libbsp/m68k/genmcf548x/include/bsp.h b/c/src/lib/libbsp/m68k/genmcf548x/include/bsp.h index 5d8ba6f6a6..68394a1e74 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 #include +/** + * @defgroup m68k_genmcf548x MCF548X Support + * + * @ingroup bsp_m68k + * + * @brief MCT548X support. + */ + #include #include #include diff --git a/c/src/lib/libbsp/m68k/genmcf548x/include/irq.h b/c/src/lib/libbsp/m68k/genmcf548x/include/irq.h index 23ff73d46f..8d58fc6a68 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 #include +/** + * @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 f8fe447335..628df982b3 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