Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed doxygen comments, focused on file headers and group definitions #251

Merged
merged 4 commits into from
Dec 16, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions boards/avsextrem/include/board.h
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@
/*
* board.h - Definitions for the AVSEXTREM board configuration.
* Copyright (C) 2013 Zakaria Kasmi <[email protected]>
*
* This source code is licensed under the LGPLv2 license,
* See the file LICENSE for more details.
*
*/
* Copyright (C) 2013 Zakaria Kasmi <[email protected]>
*
* 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$
*/


Expand Down Expand Up @@ -63,4 +64,3 @@ typedef uint8_t radio_packet_length_t;

/** @} */
#endif /* BOARDCONF_H_ */

20 changes: 20 additions & 0 deletions boards/chronos/include/board.h
Original file line number Diff line number Diff line change
@@ -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

Expand Down
16 changes: 16 additions & 0 deletions boards/doc.txt
Original file line number Diff line number Diff line change
@@ -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.
*/
20 changes: 20 additions & 0 deletions boards/msb-430-common/include/board-conf.h
Original file line number Diff line number Diff line change
@@ -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

Expand Down
34 changes: 15 additions & 19 deletions boards/msb-430/include/board.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/******************************************************************************
/*
Copyright 2009, Freie Universitaet Berlin (FUB). All rights reserved.
These sources were developed at the Freie Universitaet Berlin, Computer Systems
Expand All @@ -24,30 +24,26 @@ and the mailinglist (subscription via web site)
[email protected]
*******************************************************************************/

#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
Expand Down
29 changes: 10 additions & 19 deletions boards/msb-430h/include/board.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/******************************************************************************
/*
Copyright 2009, Freie Universitaet Berlin (FUB). All rights reserved.
These sources were developed at the Freie Universitaet Berlin, Computer Systems
Expand All @@ -24,30 +24,21 @@ and the mailinglist (subscription via web site)
[email protected]
*******************************************************************************/

#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
Expand Down
25 changes: 11 additions & 14 deletions boards/msba2-common/include/msba2_common.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/******************************************************************************
/*
Copyright 2008, Freie Universitaet Berlin (FUB). All rights reserved.

These sources were developed at the Freie Universitaet Berlin, Computer Systems
Expand All @@ -24,24 +24,21 @@ and the mailinglist (subscription via web site)
[email protected]
*******************************************************************************/

#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 <[email protected]>
* @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 <[email protected]>
*/
#ifndef __MSBA2_COMMON_H
#define __MSBA2_COMMON_H


#include <stdint.h>
#include "lpc2387.h"
Expand Down
20 changes: 20 additions & 0 deletions boards/msba2/include/board.h
Original file line number Diff line number Diff line change
@@ -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

Expand Down
31 changes: 19 additions & 12 deletions boards/native/include/board.h
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>
* @}
*
* @file board.h
* @brief Basic definitions for the native board
*
* @author Ludwig Ortmann <[email protected]>
*/

#ifndef BOARD_H
#define BOARD_H

#include <stdint.h>

void _native_LED_GREEN_OFF(void);
Expand All @@ -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 */
26 changes: 26 additions & 0 deletions boards/olimex_lpc2148/include/board.h
Original file line number Diff line number Diff line change
@@ -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 */
25 changes: 11 additions & 14 deletions boards/pttu/include/board.h
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -24,25 +24,22 @@ and the mailinglist (subscription via web site)
[email protected]
*******************************************************************************/

#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 <[email protected]>
* @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 <[email protected]>
*/

#ifndef __BOARD_H
#define __BOARD_H

#include <lpc2387.h>
#include <cpu-conf.h>

Expand Down
Loading