From c629229e8d3ed982b37f1fa75cd454b3505a20dc Mon Sep 17 00:00:00 2001 From: Hauke Petersen Date: Thu, 28 Nov 2013 12:57:41 +0100 Subject: [PATCH] Added the boards folder to the doxygen tree - added boards to riot.doxyfile - fixed group definitions for all boards --- boards/avsextrem/include/board.h | 24 +++++------ boards/chronos/include/board.h | 20 +++++++++ boards/doc.txt | 16 ++++++++ boards/msb-430-common/include/board-conf.h | 20 +++++++++ boards/msb-430/include/board.h | 34 +++++++--------- boards/msb-430h/include/board.h | 29 +++++-------- boards/msba2-common/include/msba2_common.h | 29 ++++++------- boards/msba2/include/board.h | 20 +++++++++ boards/native/include/board.h | 35 +++++++++------- boards/olimex_lpc2148/include/board.h | 26 ++++++++++++ boards/pttu/include/board.h | 25 +++++------- boards/redbee-econotag/include/board.h | 24 ++++++++--- boards/telosb/include/board.h | 47 ++++++++++------------ boards/wsn430-common/include/board-conf.h | 21 +++++++--- boards/wsn430-v1_3b/include/board.h | 45 +++++++++------------ boards/wsn430-v1_4/include/board.h | 45 +++++++++------------ doc/doxygen/riot.doxyfile | 2 +- 17 files changed, 281 insertions(+), 181 deletions(-) create mode 100644 boards/doc.txt diff --git a/boards/avsextrem/include/board.h b/boards/avsextrem/include/board.h index 4370382942..cd9d86cb45 100644 --- a/boards/avsextrem/include/board.h +++ b/boards/avsextrem/include/board.h @@ -1,23 +1,24 @@ /* -* board.h - Definitions for the AVSEXTREM board configuration. -* Copyright (C) 2013 Zakaria Kasmi -* -* This source code is licensed under the LGPLv2 license, -* See the file LICENSE for more details. -* -*/ + * Copyright (C) 2013 Zakaria Kasmi + * + * This source code is licensed under the LGPLv2 license, + * See the file LICENSE for more details. + * + */ /** - * @file + * @defgroup boards_avsextrem Avsextrem + * @ingroup boards + * @brief Boards specific drivers and configuration for the Avsextrem board + * @{ + * + * @file board.h * @brief avsextrem board configuration * * @author Freie Universität Berlin, Computer Systems & Telematics * @author Heiko Will * @author Zakaria Kasmi - * @version $Revision: 1127 $ - * - * @note $Id: board-conf.h 1127 2013-06-13 08:48:29Z kasmi$ */ @@ -63,4 +64,3 @@ typedef uint8_t radio_packet_length_t; /** @} */ #endif /* BOARDCONF_H_ */ - diff --git a/boards/chronos/include/board.h b/boards/chronos/include/board.h index c07dd4f00e..b89b2069dc 100644 --- a/boards/chronos/include/board.h +++ b/boards/chronos/include/board.h @@ -1,3 +1,23 @@ +/* + * Copyright (C) 2013 Freie Universität Berlin + * + * This file subject to the terms and conditions of the GNU Lesser General + * Public License. See the file LICENSE in the top level directory for more + * details. + */ + +/** + * @defgroup boards_chronos Chronos + * @ingroup boards + * @brief Support for the chronos board + * @{ + * + * @file board.h + * @brief Header for the chronos board + * + * @author unknwon + */ + #ifndef _MSB_BOARD_H #define _MSB_BOARD_H diff --git a/boards/doc.txt b/boards/doc.txt new file mode 100644 index 0000000000..a2ee047942 --- /dev/null +++ b/boards/doc.txt @@ -0,0 +1,16 @@ +/* + * Copyright (C) 2013 Freie Universität Berlin + * + * This file subject to the terms and conditions of the GNU Lesser General + * Public License. See the file LICENSE in the top level directory for more + * details. + */ + +/** + * @defgroup boards Boards + * @brief Board specific definitions and implementations + * + * The boards module contains all definitions and implementations, that are specific to a certain board. Boards + * generally consist of a fixed configuration of a controller and some external devices as sensors or radios. All + * aspects concerning pin-configurion, mcu clock and driver configuration should go into this module. + */ diff --git a/boards/msb-430-common/include/board-conf.h b/boards/msb-430-common/include/board-conf.h index 5a9d5b1dd0..c8dcdcfaac 100644 --- a/boards/msb-430-common/include/board-conf.h +++ b/boards/msb-430-common/include/board-conf.h @@ -1,3 +1,23 @@ +/* + * Copyright (C) 2013 Freie Universität Berlin + * + * This file subject to the terms and conditions of the GNU Lesser General + * Public License. See the file LICENSE in the top level directory for more + * details. + */ + +/** + * @defgroup boards_msb430-common MSB-430 common + * @ingroup boards + * @brief Common files for all MSB-430 boards + * @{ + * + * @file board-config.h + * @brief Common definitions for all msb-430 based boards + * + * @author unknown + */ + #ifndef BOARD_CONF_H #define BOARD_CONF_H diff --git a/boards/msb-430/include/board.h b/boards/msb-430/include/board.h index e7968f4499..1254cbde81 100644 --- a/boards/msb-430/include/board.h +++ b/boards/msb-430/include/board.h @@ -1,4 +1,4 @@ -/****************************************************************************** +/* Copyright 2009, Freie Universitaet Berlin (FUB). All rights reserved. These sources were developed at the Freie Universitaet Berlin, Computer Systems @@ -24,30 +24,26 @@ and the mailinglist (subscription via web site) scatterweb@lists.spline.inf.fu-berlin.de *******************************************************************************/ -#ifndef _MSB_BOARD_H -#define _MSB_BOARD_H - /** - * @defgroup msb_430h ScatterWeb MSB-430H - * @ingroup msp430 + * @defgroup boards_msb430 MSB-430 + * @ingroup boards + * @brief Support for the msb-430 board * -

Compontents

-\li MSP430 -\li CC1100 - -* @{ -*/ - -/** - * @file - * @brief MSB-430H Board + *

Compontents

+ * \li MSP430 + * \li CC1100 + * + * @{ + * + * @file board.h + * @brief Central defnitions for the ScatterWeb MSB-430 board * * @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project - * @version $Revision$ - * - * @note $Id$ */ +#ifndef _MSB_BOARD_H +#define _MSB_BOARD_H + #include "board-conf.h" //MSB430 core diff --git a/boards/msb-430h/include/board.h b/boards/msb-430h/include/board.h index fc086d53cb..aa4e5f6179 100644 --- a/boards/msb-430h/include/board.h +++ b/boards/msb-430h/include/board.h @@ -1,4 +1,4 @@ -/****************************************************************************** +/* Copyright 2009, Freie Universitaet Berlin (FUB). All rights reserved. These sources were developed at the Freie Universitaet Berlin, Computer Systems @@ -24,30 +24,21 @@ and the mailinglist (subscription via web site) scatterweb@lists.spline.inf.fu-berlin.de *******************************************************************************/ -#ifndef _MSB_BOARD_H -#define _MSB_BOARD_H - /** - * @defgroup msb_430h ScatterWeb MSB-430H - * @ingroup msp430 + * @defgroup boards_msb430h MSB-430H + * @ingroup boards + * @brief Support for the ScatterWeb MSB-430H board + * @{ * -

Compontents

-\li MSP430 -\li CC1100 - -* @{ -*/ - -/** - * @file - * @brief MSB-430H Board + * @file board.h + * @brief Basic definitions for the MSB-430H board * * @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project - * @version $Revision$ - * - * @note $Id$ */ +#ifndef _MSB_BOARD_H +#define _MSB_BOARD_H + //MSB430 core #define MSP430_INITIAL_CPU_SPEED 7372800uL #define MSP430_HAS_DCOR 1 diff --git a/boards/msba2-common/include/msba2_common.h b/boards/msba2-common/include/msba2_common.h index 4e56c82ab7..147b924c48 100644 --- a/boards/msba2-common/include/msba2_common.h +++ b/boards/msba2-common/include/msba2_common.h @@ -1,4 +1,4 @@ -/****************************************************************************** +/* Copyright 2008, Freie Universitaet Berlin (FUB). All rights reserved. These sources were developed at the Freie Universitaet Berlin, Computer Systems @@ -24,24 +24,21 @@ and the mailinglist (subscription via web site) scatterweb@lists.spline.inf.fu-berlin.de *******************************************************************************/ +/** + * @defgroup boards_msba2-common MSB-A2 common + * @ingroup boards + * @brief Common files for all MSB-A2 based boards + * @{ + * + * @files msba2-common.h + * @brief MSB-A2 Common Board Definitions + * + * @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project + * @author Kaspar Schleiser + */ #ifndef __MSBA2_COMMON_H #define __MSBA2_COMMON_H -/** - * @ingroup msb_a2 - * @{ - */ - -/** - * @file - * @brief MSB-A2 Common Board Definitions - * - * @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project - * @author Kaspar Schleiser - * @version $Revision$ - * - * @note $Id$ - */ #include #include "lpc2387.h" diff --git a/boards/msba2/include/board.h b/boards/msba2/include/board.h index 829715b3c2..00cf16181c 100644 --- a/boards/msba2/include/board.h +++ b/boards/msba2/include/board.h @@ -1,3 +1,23 @@ +/* + * Copyright (C) 2013 Freie Universität Berlin + * + * This file subject to the terms and conditions of the GNU Lesser General + * Public License. See the file LICENSE in the top level directory for more + * details. + */ + +/** + * @defgroup boards_msba2 MSB-A2 + * @ingroup boards + * @brief Support for the MSB-A2 board + * @{ + * + * @file board.h + * @brief Basic definitions for the MSB-A2 board + * + * @author unknown + */ + #ifndef __BOARD_H #define __BOARD_H diff --git a/boards/native/include/board.h b/boards/native/include/board.h index 7c2c31daae..4e3df1cdc0 100644 --- a/boards/native/include/board.h +++ b/boards/native/include/board.h @@ -1,23 +1,28 @@ -#ifndef BOARD_H -#define BOARD_H - -/** - * Native Board interface - * - * The native board uses call level hardware simulation. - * +/* * Copyright (C) 2013 Ludwig Ortmann * * This file is subject to the terms and conditions of the LGPLv2. See * the file LICENSE in the top level directory for more details. - * - * @defgroup native_board - * @{ - * @file - * @author Ludwig Ortmann - * @} */ +/** + * @defgroup boards_native Native Board + * @ingroup boards + * @brief Board emulation for the native port + * + * The native board uses call level hardware simulation + * + * @{ + * + * @file board.h + * @brief Basic definitions for the native board + * + * @author Ludwig Ortmann + */ + +#ifndef BOARD_H +#define BOARD_H + #include void _native_LED_GREEN_OFF(void); @@ -34,4 +39,6 @@ void _native_LED_RED_TOGGLE(void); #define LED_RED_TOGGLE (_native_LED_RED_TOGGLE()) typedef uint16_t radio_packet_length_t; + +/** @} */ #endif /* BOARD_H */ diff --git a/boards/olimex_lpc2148/include/board.h b/boards/olimex_lpc2148/include/board.h index ff961ea366..e7bee9b5f6 100644 --- a/boards/olimex_lpc2148/include/board.h +++ b/boards/olimex_lpc2148/include/board.h @@ -1,4 +1,30 @@ +/* + * Copyright (C) 2013 Freie Universität Berlin + * + * This file subject to the terms and conditions of the GNU Lesser General + * Public License. See the file LICENSE in the top level directory for more + * details. + */ + +/** + * @defgroup boards_olimex_lpc2148 Olimex LPC2148 + * @ingroup boards + * @brief Support for the Olimex LPC2148 board + * @{ + * + * @file board.h + * @brief Basic definitions for the Olimex LPC2148 board + * + * @author unknown + */ + +#ifndef __OLIMEX_LPC2148_H +#define __OLIMEX_LPC2148_H + #include #include "lpc2148.h" typedef uint8_t radio_packet_length_t; + +/** @} */ +#endif /* __OLIMEX_LPC2148_H */ diff --git a/boards/pttu/include/board.h b/boards/pttu/include/board.h index ba7b3f42bf..2ee3308f99 100644 --- a/boards/pttu/include/board.h +++ b/boards/pttu/include/board.h @@ -1,4 +1,4 @@ -/****************************************************************************** +/* Copyright 2008-2009, Freie Universitaet Berlin (FUB). All rights reserved. These sources were developed at the Freie Universitaet Berlin, Computer Systems @@ -24,25 +24,22 @@ and the mailinglist (subscription via web site) scatterweb@lists.spline.inf.fu-berlin.de *******************************************************************************/ -#ifndef __BOARD_H -#define __BOARD_H - /** - * @ingroup pttu + * @defgroup boards_pttu PTTU + * @ingroup boards + * @brief Support for the PTTU board * @{ - */ - -/** - * @file - * @brief PTTU Board + * + * @file board.h + * @brief Basic definitions for the PTTU board * * @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project - * @author Kaspar Schleiser - * @version $Revision$ - * - * @note $Id: board.h 664 2009-02-19 10:54:44Z baar $ + * @author Kaspar Schleiser */ +#ifndef __BOARD_H +#define __BOARD_H + #include #include diff --git a/boards/redbee-econotag/include/board.h b/boards/redbee-econotag/include/board.h index bbcb2b07d3..95db044fef 100644 --- a/boards/redbee-econotag/include/board.h +++ b/boards/redbee-econotag/include/board.h @@ -1,10 +1,22 @@ +/* + * Copyright (C) 2013 Thomas Eichinger + * + * This file subject to the terms and conditions of the GNU Lesser General + * Public License. See the file LICENSE in the top level directory for more + * details. + */ + /** - * board.h - redbee-econotag Board. - * Copyright (C) 2013 Thomas Eichinger - * - * This source code is licensed under the GNU Lesser General Public License, - * Version 2. See the file LICENSE for more details. - */ + * @defgroup boards_redbee-econotag Redbee Econotag + * @ingroup boards + * @brief Support for the Redbee Econotag board + * @{ + * + * @file board.h + * @brief Basic definitions for the Redbee Econotag board + * + * @author Thomas Eichinger + */ #ifndef REDBEE_ECONOTAG_BOARD_H #define REDBEE_ECONOTAG_BOARD_H diff --git a/boards/telosb/include/board.h b/boards/telosb/include/board.h index 55fd2a35b4..d0d16bac46 100644 --- a/boards/telosb/include/board.h +++ b/boards/telosb/include/board.h @@ -1,33 +1,30 @@ +/* + * Copyright (C) 2013 INRIA + * + * This source code is licensed under the GNU Lesser General Public License, + * Version 2. See the file LICENSE for more details. + */ + /** - * board.h - TelosB Board. - * Copyright (C) 2013 INRIA - * - * This source code is licensed under the GNU Lesser General Public License, - * Version 2. See the file LICENSE for more details. - */ + * @defgroup boards_telosb TelosB + * @ingroup boards + * @brief Support for the TelosB board + * + *

Compontents

+ * \li MSP430 + * \li CC2420 + * + * @{ + * + * @file board.h + * @brief Basic definitions for the TelosB board + * + * @author Oliver Hahm + */ #ifndef _TELOSB_BOARD_H #define _TELOSB_BOARD_H -/** - * @defgroup TelosB - * @ingroup TelosB - * -

Compontents

-\li MSP430 -\li CC2420 - -* @{ -*/ - -/** - * @file - * @brief TelosB Board - * - * @author Oliver Hahm - * - */ - //MSB430 core #define MSP430_INITIAL_CPU_SPEED 8000000uL #define MSP430_HAS_DCOR 0 diff --git a/boards/wsn430-common/include/board-conf.h b/boards/wsn430-common/include/board-conf.h index e54b3d58eb..aedd1542a9 100644 --- a/boards/wsn430-common/include/board-conf.h +++ b/boards/wsn430-common/include/board-conf.h @@ -1,9 +1,19 @@ +/* + * This source code is licensed under the GNU Lesser General Public License, + * Version 2. See the file LICENSE for more details. + */ + /** - * board-conf.h. - * - * This source code is licensed under the GNU Lesser General Public License, - * Version 2. See the file LICENSE for more details. - */ + * @defgroup boards_wsn430-common WSN430 common + * @ingroup boards + * @brief Common files for WSN430 based boards + * @{ + * + * @file board.h + * @brief Common definitions for WSN430 based boards + * + * @author unknown + */ #ifndef BOARD_CONF_H #define BOARD_CONF_H @@ -12,4 +22,5 @@ #define INFOMEM (0x1000) +/** @} */ #endif /* BOARD-CONF_H */ diff --git a/boards/wsn430-v1_3b/include/board.h b/boards/wsn430-v1_3b/include/board.h index 9a23fdf8d7..5c32458ef6 100644 --- a/boards/wsn430-v1_3b/include/board.h +++ b/boards/wsn430-v1_3b/include/board.h @@ -1,36 +1,31 @@ -/** - * board.h - wsn430-v1_3b Board. - * Copyright (C) 2013 Milan Babel - * - * This source code is licensed under the GNU Lesser General Public License, - * Version 2. See the file LICENSE for more details. - */ - -#ifndef _WSN_BOARD_H -#define _WSN_BOARD_H - -/** - * @defgroup wsn430-v1_3b Senslab WSN430 v1.3b - * @ingroup wsn430 +/* + * Copyright (C) 2013 Milan Babel * -

Compontents

-\li MSP430 -\li CC1100 - -* @{ -*/ + * This source code is licensed under the GNU Lesser General Public License, + * Version 2. See the file LICENSE for more details. + */ /** - * @file - * @brief wsn430-v1_3b Board + * @defgroup boards_wsn430-v1_3b WSN430 v1.3b + * @ingroup boards + * @brief Support for the Senslab WSN430 v1.3b board + * + *

Compontents

+ * \li MSP430 + * \li CC1100 + * + * @{ + * + * @file board.h + * @brief Basic definitions for the Senslab WSN430 v1.3b board * * @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project * @author Milan Babel - * @version $Revision$ - * - * @note $Id$ */ +#ifndef _WSN_BOARD_H +#define _WSN_BOARD_H + #include "board-conf.h" //MSB430 core diff --git a/boards/wsn430-v1_4/include/board.h b/boards/wsn430-v1_4/include/board.h index 092bc76998..8041896a8a 100644 --- a/boards/wsn430-v1_4/include/board.h +++ b/boards/wsn430-v1_4/include/board.h @@ -1,36 +1,31 @@ -/** - * board.h - wsn430-v1_4 Board. - * Copyright (C) 2013 Milan Babel - * - * This source code is licensed under the GNU Lesser General Public License, - * Version 2. See the file LICENSE for more details. - */ - -#ifndef _WSN_BOARD_H -#define _WSN_BOARD_H - -/** - * @defgroup wsn430-v1_4 Senslab WSN430 v1.4 - * @ingroup wsn430 +/* + * Copyright (C) 2013 Milan Babel * -

Compontents

-\li MSP430 -\li CC2420 - -* @{ -*/ + * This source code is licensed under the GNU Lesser General Public License, + * Version 2. See the file LICENSE for more details. + */ /** - * @file - * @brief wsn430-v1_4 Board + * @defgroup boards_wsn430-v1_4 WSN430 v1.4 + * @ingroup boards + * @brief Support for the Senslab WSN430 v1.4 board + * + *

Compontents

+ * \li MSP430 + * \li CC2420 + * + * @{ + * + * @file board.h + * @brief Basic definitions for the Senslab WSN430 v1.4 board * * @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project * @author Milan Babel - * @version $Revision$ - * - * @note $Id$ */ +#ifndef _WSN_BOARD_H +#define _WSN_BOARD_H + #include "board-conf.h" //MSB430 core diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index 12277c9db0..ad4dc35dcd 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -85,7 +85,7 @@ WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = ../../core ../../cpu ../../../boards ../../sys src/ ../../drivers +INPUT = ../../core ../../cpu ../../boards ../../sys src/ ../../drivers INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.txt *.c *.h RECURSIVE = YES