From d48ac1814446d71e567d4d6c44bda39a753f5e55 Mon Sep 17 00:00:00 2001 From: Szkocsovszki Zsolt Date: Wed, 1 Jan 2014 22:30:24 +0100 Subject: m68k/gen68360: Improve Doxygen --- c/src/lib/libbsp/m68k/gen68360/include/bsp.h | 18 +++++++++++++++--- c/src/lib/libbsp/m68k/gen68360/include/coverhd.h | 9 +++++++-- c/src/lib/libbsp/m68k/gen68360/include/tm27.h | 18 ++++++++++++++---- 3 files changed, 36 insertions(+), 9 deletions(-) (limited to 'c/src/lib/libbsp/m68k/gen68360/include') 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 #include -/* - * 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 -- cgit v1.2.3