Added the boards folder to the doxygen tree

- added boards to riot.doxyfile - fixed group definitions for all boards
RIOT-OS · Dec 16, 2013 · c629229 · c629229
1 parent edcabf7
commit c629229
Show file tree

Hide file tree

Showing 17 changed files with 275 additions and 175 deletions.
diff --git 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 <zkasmi@inf.fu-berlin.de>
-*
-* This source code is licensed under the LGPLv2 license,
-* See the file LICENSE for more details.
-*
-*/
+ * Copyright (C) 2013 Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
+ *
+ * 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
@@ -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
@@ -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
@@ -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
@@ -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
  *
-<h2>Compontents</h2>
-\li MSP430
-\li CC1100
-
-* @{
-*/
-
-/**
- * @file
- * @brief		MSB-430H Board
+ * <h2>Compontents</h2>
+ * \li MSP430
+ * \li CC1100
+ * 
+ * @{
  *
- * @author      Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project
- * @version     $Revision$
+ * @file        board.h
+ * @brief       Central defnitions for the ScatterWeb MSB-430 board
  *
- * @note		$Id$
+ * @author      Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project
  */
 
+#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
@@ -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
+ * @{
  *
-<h2>Compontents</h2>
-\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
@@ -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
 *******************************************************************************/
 
-#ifndef __MSBA2_COMMON_H
-#define __MSBA2_COMMON_H
-
 /**
- * @ingroup		msb_a2
+ * @defgroup    boards_msba2-common MSB-A2 common
+ * @ingroup     boards
+ * @brief       Common files for all MSB-A2 based boards
  * @{
- */
-
-/**
- * @file
- * @brief		MSB-A2 Common Board Definitions
  *
- * @author      Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project
- * @author		Kaspar Schleiser <kaspar@schleiser.de>
- * @version     $Revision$
+ * @files       msba2-common.h
+ * @brief       MSB-A2 Common Board Definitions
  *
- * @note		$Id$
+ * @author      Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project
+ * @author      Kaspar Schleiser <kaspar@schleiser.de>
  */
+#ifndef __MSBA2_COMMON_H
+#define __MSBA2_COMMON_H
+
 
 #include <stdint.h>
 #include "lpc2387.h"

diff --git 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
@@ -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    boards_native Native Board
+ * @ingroup     boards
+ * @brief       Board emulation for the native port
+ *
+ * The native board uses call level hardware simulation
  *
- * @defgroup native_board
  * @{
- * @file
- * @author  Ludwig Ortmann <ludwig.ortmann@fu-berlin.de>
- * @}
+ *
+ * @file        board.h
+ * @brief       Basic definitions for the native board
+ *
+ * @author      Ludwig Ortmann <ludwig.ortmann@fu-berlin.de>
  */
 
+#ifndef BOARD_H
+#define BOARD_H
+
 #include <stdint.h>
 
 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
@@ -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 <stdint.h>
 #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
@@ -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
  *
- * @author      Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project
- * @author		Kaspar Schleiser <kaspar@schleiser.de>
- * @version     $Revision$
+ * @file        board.h
+ * @brief       Basic definitions for the PTTU board
  *
- * @note		$Id: board.h 664 2009-02-19 10:54:44Z baar $
+ * @author      Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project
+ * @author      Kaspar Schleiser <kaspar@schleiser.de>
  */
 
+#ifndef __BOARD_H
+#define __BOARD_H
+
 #include <lpc2387.h>
 #include <cpu-conf.h>