riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #8189 from smlng/doc/boards_common

Browse Source 
Doc: fix and improve doxygen grouping of boards_common
This commit is contained in:
Martine Lenders 2017-12-18 10:52:12 +01:00 committed by GitHub
commit 93ca3345e6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
62 changed files with 144 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
boards/common/arduino-atmega/board.c
View File

@ -9,7 +9,7 @@
*/ */
/** /**
* @ingroup boards_arduino-atmega-common * @ingroup boards_common_arduino-atmega
* @{ * @{
* *
* @file * @file

2
boards/common/arduino-atmega/include/arduino_board.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup boards_arduino-atmega-common * @ingroup boards_common_arduino-atmega
* @{ * @{
* *
* @file * @file

2
boards/common/arduino-atmega/include/arduino_pinmap.h
View File

@ -8,7 +8,7 @@
*/ */
/** /**
* @ingroup boards_arduino-atmega-common * @ingroup boards_common_arduino-atmega
* @{ * @{
* *
* @file * @file

4
boards/common/arduino-atmega/include/board_common.h
View File

@ -8,7 +8,9 @@
*/ */
/* /*
* @ingroup boards_arduino-atmega-common * @defgroup boards_common_arduino-atmega Arduino Atmega Common
* @ingroup boards_common
* @brief Shared files and configuration for Arduino Atmega boards.
* @{ * @{
* *
* @file * @file

2
boards/common/arduino-atmega/include/gpio_params.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup boards_arduino-atmega-common * @ingroup boards_common_arduino-atmega
* @{ * @{
* *
* @file * @file

2
boards/common/arduino-atmega/include/periph_conf.h
View File

@ -9,7 +9,7 @@
*/ */
/** /**
* @ingroup boards_arduino-atmega-common * @ingroup boards_common_arduino-atmega
* @{ * @{
* *
* @file * @file

6
boards/common/arduino-due/include/board.h
View File

@ -7,9 +7,9 @@
*/ */
/** /**
* @defgroup boards_common_arduino_due Shared Arduino Due Code * @defgroup boards_common_arduino_due Arduino Due Common
* @ingroup boards * @ingroup boards_common
* @brief Shared code for Arduino Due based boards * @brief Shared files and configuration for Arduino Due based boards.
* @{ * @{
* *
* @file * @file

3
boards/common/arduino-mkr/board.c
View File

@ -9,12 +9,13 @@
/** /**
* @ingroup boards_arduino-mkr-common * @ingroup boards_arduino-mkr-common
* * @{
* @file * @file
* @brief Board common implementations for the Arduino MKR boards * @brief Board common implementations for the Arduino MKR boards
* *
* @author Hauke Pertersen <hauke.pertersen@fu-berlin.de> * @author Hauke Pertersen <hauke.pertersen@fu-berlin.de>
* @author Alexandre Abadie <alexandre.abadie@inria.fr> * @author Alexandre Abadie <alexandre.abadie@inria.fr>
*
* @} * @}
*/ */

2
boards/common/arduino-mkr/include/arduino_board.h
View File

@ -8,7 +8,7 @@
*/ */
/** /**
* @ingroup boards_arduino-mkr1000 * @ingroup boards_common_arduino-mkr
* @{ * @{
* *
* @file * @file

2
boards/common/arduino-mkr/include/arduino_pinmap.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup boards_arduino-mkr-common * @ingroup boards_common_arduino-mkr
* @{ * @{
* *
* @file * @file

6
boards/common/arduino-mkr/include/board_common.h
View File

@ -7,9 +7,9 @@
*/ */
/** /**
* @defgroup boards_arduino-mkr-common Arduino MKR Common * @defgroup boards_common_arduino-mkr Arduino MKR Common
* @ingroup boards * @ingroup boards_common
* @brief Support for the Arduino MKR boards type. * @brief Shared files and configuration for the Arduino MKR boards type.
* @{ * @{
* *
* @file * @file

2
boards/common/arduino-mkr/include/gpio_params.h
View File

@ -8,7 +8,7 @@
*/ */
/** /**
* @ingroup boards_arduino-mkr-common * @ingroup boards_common_arduino-mkr
* @{ * @{
* *
* @file * @file

2
boards/common/arduino-mkr/include/periph_conf.h
View File

@ -8,7 +8,7 @@
*/ */
/** /**
* @ingroup boards_arduino-mkr-common * @ingroup boards_common_arduino-mkr
* @{ * @{
* *
* @file * @file

16
boards/common/doc.txt Normal file
View File

@ -0,0 +1,16 @@
/*
* Copyright (C) 2017 HAW Hamburg
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup boards_common Common Board Groups
* @ingroup boards
* @brief Common definitions and implementations for board groups
*
* Several boards share many definitions and implementations, these are
* collectively stored into a common module per board group.
*/

6
boards/common/arduino-atmega/doc.txt → boards/common/frdm/doc.txt
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @defgroup boards_arduino-atmega-common Arduino Atmega Common * @defgroup boards_common_frdm NXP FRDM Common
* @ingroup boards * @ingroup boards_common
* @brief Common configuration and settings for Arduino Atmega boards * @brief Shared files and configuration for the NXP Freedom Boards.
*/ */

6
boards/common/iotlab/include/board_common.h
View File

@ -7,9 +7,9 @@
*/ */
/** /**
* @defgroup boards_iotlab-m3 IoT-LAB M3 open node * @defgroup boards_common_iotlab IoTlab Common
* @ingroup boards * @ingroup boards_common
* @brief Board specific files for the iotlab-m3 board. * @brief Shared files and configuration for the IoTlab boards.
* @{ * @{
* *
* @file * @file

2
boards/common/iotlab/include/gpio_params.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup boards_iotlab-m3 * @ingroup boards_common_iotlab
* @{ * @{
* *
* @file * @file

2
boards/common/iotlab/include/l3g4200d_params.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup boards_iotlab-m3 * @ingroup boards_common_iotlab
* @{ * @{
* *
* @file * @file

2
boards/common/iotlab/include/lsm303dlhc_params.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup boards_iotlab-m3 * @ingroup boards_common_iotlab
* @{ * @{
* *
* @file * @file

2
boards/common/iotlab/include/periph_conf_common.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup boards_iotlab-m3 * @ingroup boards_common_iotlab
* @{ * @{
* *
* @file * @file

4
boards/common/msb-430/board_init.c
View File

@ -9,15 +9,13 @@
/** /**
* @ingroup boards * @ingroup boards
* @{ * @{
*/
/**
* @file * @file
* @brief msb-430 common board initialization * @brief msb-430 common board initialization
* *
* @author Oliver Hahm <oliver.hahm@inria.fr> * @author Oliver Hahm <oliver.hahm@inria.fr>
* @author Kaspar Schleiser <kaspar@schleiser.de> * @author Kaspar Schleiser <kaspar@schleiser.de>
* *
* @}
*/ */
#include "cpu.h" #include "cpu.h"

2
boards/common/msb-430/drivers/include/sht11-board.h
View File

@ -10,7 +10,7 @@
#define SHT11_BOARD_H #define SHT11_BOARD_H
/** /**
* @ingroup msb_430h * @ingroup boards_common_msb-430
* @{ * @{
*/ */

6
boards/common/msb-430/include/board_common.h
View File

@ -7,9 +7,9 @@
*/ */
/** /**
* @defgroup boards_msb430-common MSB-430 common * @defgroup boards_common_msb-430 MSB-430 common
* @ingroup boards * @ingroup boards_common
* @brief Common files for all MSB-430 boards * @brief Shared files and configuration for all MSB-430 boards.
* @{ * @{
* *
* @file * @file

7
boards/common/msba2/board_common_init.c
View File

@ -7,11 +7,8 @@
*/ */
/** /**
* @ingroup msba2 * @ingroup boards_common_msba2
* @{ * @{
*/
/**
* @file * @file
* @brief MSB-A2 board initialization * @brief MSB-A2 board initialization
* *
@ -20,6 +17,8 @@
* @author Michael Baar <baar@inf.fu-berlin.de> * @author Michael Baar <baar@inf.fu-berlin.de>
* @author Zakaria Kasmi <zkasmi@inf.fu-berlin.de> * @author Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
* @note $Id$ * @note $Id$
*
* @}
*/ */
#include <string.h> #include <string.h>
#include "board.h" #include "board.h"

6
boards/common/msba2/include/msba2_common.h
View File

@ -7,9 +7,9 @@
*/ */
/** /**
* @defgroup boards_msba2-common MSB-A2 common * @defgroup boards_common_msba2 MSB-A2 common
* @ingroup boards * @ingroup boards_common
* @brief Common files for all MSB-A2 based boards * @brief Shared files and configuration for all MSB-A2 boards.
* @{ * @{
* *
* @file * @file

2
boards/common/nrf52xxxdk/board.c
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup boards_nrf52840dk * @ingroup boards_common_nrf52
* @{ * @{
* *
* @file * @file

4
boards/common/nrf52xxxdk/include/board_common.h
View File

@ -7,9 +7,9 @@
*/ */
/** /**
* @defgroup boards_common_nrf52 Shared nRF52 code * @defgroup boards_common_nrf52 NRF52 common
* @ingroup boards_common * @ingroup boards_common
* @brief Shared configuration for all nRF52-based boards * @brief Shared files and configuration for all nRF52 boards.
* @{ * @{
* *
* @file * @file

2
boards/common/nrf52xxxdk/include/gpio_params.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup boards_nrf52dk * @ingroup boards_common_nrf52
* @{ * @{
* *
* @file * @file

2
boards/common/nrf52xxxdk/include/periph_conf.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup boards_nrf52dk * @ingroup boards_common_nrf52
* @{ * @{
* *
* @file * @file

2
boards/common/nucleo/include/arduino_board.h
View File

@ -8,7 +8,7 @@
*/ */
/** /**
* @ingroup boards_nucleo-common * @ingroup boards_common_nucleo
* @{ * @{
* *
* @file * @file

2
boards/common/nucleo/include/arduino_pinmap.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup boards_nucleo-common * @ingroup boards_common_nucleo
* @{ * @{
* *
* @file * @file

13
boards/common/nucleo/include/board_common.h
View File

@ -7,15 +7,12 @@
*/ */
/** /**
* @defgroup boards_nucleo STM Nucleo boards * @defgroup boards_nucleo STM Nucleo Boards
* @ingroup boards * @ingroup boards
* @brief STM Nucleo boards *
*/ * @defgroup boards_common_nucleo STM Nucleo common
* @ingroup boards_common
/** * @brief Shared files and configuration for all STM Nucleo boards.
* @defgroup boards_nucleo64_common STM Nucleo 64 boards common
* @ingroup boards_nucleo
* @brief Common files for STM Nucleo 64 boards
* @{ * @{
* *
* @file * @file

2
boards/common/nucleo/include/gpio_params.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup boards_nucleo-common * @ingroup boards_common_nucleo
* @{ * @{
* *
* @file * @file

2
boards/common/nucleo144/include/arduino_board.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup boards_nucleo144-common * @ingroup boards_common_nucleo144
* @{ * @{
* *
* @file * @file

2
boards/common/nucleo144/include/arduino_pinmap.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup boards_nucleo144-common * @ingroup boards_common_nucleo144
* @{ * @{
* *
* @file * @file

9
boards/common/nucleo144/include/board_common.h
View File

@ -8,9 +8,12 @@
*/ */
/** /**
* @defgroup boards_nucleo144-common STM Nucleo-144 Common * @defgroup boards_nucleo144 STM Nucleo144 Boards
* @ingroup boards_nucleo * @ingroup boards
* @brief Common files for STM Nucleo-144 boards *
* @defgroup boards_common_nucleo144 STM Nucleo144 common
* @ingroup boards_common
* @brief Shared files and configuration for all STM Nucleo144 boards.
* @{ * @{
* *
* @file * @file

2
boards/common/nucleo144/include/gpio_params.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup boards_nucleo144-common * @ingroup boards_common_nucleo144
* @{ * @{
* *
* @file * @file

2
boards/common/nucleo32/include/arduino_board.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup boards_nucleo32-common * @ingroup boards_common_nucleo32
* @{ * @{
* *
* @file * @file

2
boards/common/nucleo32/include/arduino_pinmap.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup boards_nucleo32-common * @ingroup boards_common_nucleo32
* @{ * @{
* *
* @file * @file

9
boards/common/nucleo32/include/board_common.h
View File

@ -7,9 +7,12 @@
*/ */
/** /**
* @defgroup boards_nucleo32-common STM Nucleo-32 Common * @defgroup boards_nucleo32 STM Nucleo32 Boards
* @ingroup boards_nucleo * @ingroup boards
* @brief Common files for STM Nucleo-32 boards *
* @defgroup boards_common_nucleo32 STM Nucleo32 common
* @ingroup boards_common
* @brief Shared files and configuration for all STM Nucleo32 boards.
* @{ * @{
* *
* @file * @file

2
boards/common/nucleo32/include/gpio_params.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup boards_nucleo32-common * @ingroup boards_common_nucleo32
* @{ * @{
* *
* @file * @file

5
boards/common/remote/include/board_common.h
View File

@ -8,8 +8,9 @@
*/ */
/** /**
* @ingroup boards_remote * @defgroup boards_common_remote Zolertia Re-Mote common
* @brief Support for the RE-Mote boards * @ingroup boards_common
* @brief Shared files and configuration for all Zolertia Re-Mote boards.
* @{ * @{
* *
* @file * @file

3
boards/common/remote/include/fancy_leds.h
View File

@ -8,8 +8,7 @@
*/ */
/** /**
* @ingroup boards_remote * @ingroup boards_common_remote
* @brief LED extension
* @{ * @{
* *
* @file * @file

2
boards/common/remote/include/periph_common.h
View File

@ -8,7 +8,7 @@
*/ */
/** /**
* @ingroup boards_remote * @ingroup boards_common_remote
* @{ * @{
* *
* @file * @file

12
boards/common/wsn430/board_init.c
View File

@ -7,6 +7,18 @@
* directory for more details. * directory for more details.
*/ */
/**
* @ingroup boards_common_wsn430
* @{
*
* @file
* @brief Board initialization for WSN430
*
* @author Milan Babel <babel@inf.fu-berlin.de>
*
* @}
*/
#include "cpu.h" #include "cpu.h"
#include "irq.h" #include "irq.h"
#include "board.h" #include "board.h"

6
boards/common/wsn430/include/board_common.h
View File

@ -8,9 +8,9 @@
*/ */
/** /**
* @defgroup boards_wsn430-common WSN430 common * @defgroup boards_common_wsn430 WSN430 common
* @ingroup boards * @ingroup boards_common
* @brief Common files for WSN430 based boards * @brief Shared files and configuration for all WSN430 based boards.
* @{ * @{
* *
* @file * @file

2
boards/common/wsn430/include/periph_conf.h
View File

@ -8,7 +8,7 @@
*/ */
/** /**
* @ingroup boards_wsn430-common * @ingroup boards_common_wsn430
* @{ * @{
* *
* @file * @file

2
boards/nucleo144-f207/include/board.h
View File

@ -8,7 +8,7 @@
/** /**
* @defgroup boards_nucleo144-f207 Nucleo144-F207 * @defgroup boards_nucleo144-f207 Nucleo144-F207
* @ingroup boards_nucleo * @ingroup boards_nucleo144
* @brief Board specific files for the nucleo144-f207 board * @brief Board specific files for the nucleo144-f207 board
* @{ * @{
* *

2
boards/nucleo144-f303/include/board.h
View File

@ -8,7 +8,7 @@
/** /**
* @defgroup boards_nucleo144-f303 Nucleo144-F303 * @defgroup boards_nucleo144-f303 Nucleo144-F303
* @ingroup boards_nucleo * @ingroup boards_nucleo144
* @brief Board specific files for the nucleo144-f303 board * @brief Board specific files for the nucleo144-f303 board
* @{ * @{
* *

6
boards/nucleo144-f412/include/board.h
View File

@ -8,9 +8,9 @@
*/ */
/** /**
* @defgroup boards_nucleo144-f412 Nucleo-F412 * @defgroup boards_nucleo144-f412 Nucleo144-F412
* @ingroup boards_nucleo * @ingroup boards_nucleo144
* @brief Board specific files for the nucleo144-f412 board * @brief Board specific files for the STM Nucleo144-f412 board
* @{ * @{
* *
* @file * @file

6
boards/nucleo144-f413/include/board.h
View File

@ -8,9 +8,9 @@
*/ */
/** /**
* @defgroup boards_nucleo144-f413 Nucleo-F413 * @defgroup boards_nucleo144-f413 Nucleo144-F413
* @ingroup boards_nucleo * @ingroup boards_nucleo144
* @brief Board specific files for the nucleo144-f413 board * @brief Board specific files for the STM Nucleo144-f413 board
* @{ * @{
* *
* @file * @file

2
boards/nucleo144-f429/include/board.h
View File

@ -8,7 +8,7 @@
/** /**
* @defgroup boards_nucleo144-f429 Nucleo144-F429 * @defgroup boards_nucleo144-f429 Nucleo144-F429
* @ingroup boards_nucleo * @ingroup boards_nucleo144
* @brief Board specific files for the nucleo144-f429 board * @brief Board specific files for the nucleo144-f429 board
* @{ * @{
* *

2
boards/nucleo144-f446/include/board.h
View File

@ -8,7 +8,7 @@
/** /**
* @defgroup boards_nucleo144-f446 Nucleo144-F446 * @defgroup boards_nucleo144-f446 Nucleo144-F446
* @ingroup boards_nucleo * @ingroup boards_nucleo144
* @brief Board specific files for the nucleo144-f446 board * @brief Board specific files for the nucleo144-f446 board
* @{ * @{
* *

2
boards/nucleo144-f722/include/board.h
View File

@ -8,7 +8,7 @@
/** /**
* @defgroup boards_nucleo144-f722 Nucleo144-F722 * @defgroup boards_nucleo144-f722 Nucleo144-F722
* @ingroup boards * @ingroup boards_nucleo144
* @brief Board specific files for the nucleo144-f722 board * @brief Board specific files for the nucleo144-f722 board
* @{ * @{
* *

2
boards/nucleo144-f746/include/board.h
View File

@ -8,7 +8,7 @@
/** /**
* @defgroup boards_nucleo144-f746 Nucleo144-F746 * @defgroup boards_nucleo144-f746 Nucleo144-F746
* @ingroup boards_nucleo * @ingroup boards_nucleo144
* @brief Board specific files for the nucleo144-f746 board * @brief Board specific files for the nucleo144-f746 board
* @{ * @{
* *

2
boards/nucleo144-f767/include/board.h
View File

@ -8,7 +8,7 @@
/** /**
* @defgroup boards_nucleo144-f767 Nucleo144-F767 * @defgroup boards_nucleo144-f767 Nucleo144-F767
* @ingroup boards_nucleo * @ingroup boards_nucleo144
* @brief Board specific files for the nucleo144-f767 board * @brief Board specific files for the nucleo144-f767 board
* @{ * @{
* *

2
boards/nucleo32-f031/include/board.h
View File

@ -9,7 +9,7 @@
/** /**
* @defgroup boards_nucleo32-f031 Nucleo32-F031 * @defgroup boards_nucleo32-f031 Nucleo32-F031
* @ingroup boards_nucleo * @ingroup boards_nucleo32
* @brief Board specific files for the nucleo32-f031 board * @brief Board specific files for the nucleo32-f031 board
* @{ * @{
* *

6
boards/nucleo32-f042/include/board.h
View File

@ -7,9 +7,9 @@
*/ */
/** /**
* @defgroup boards_nucleo32-f042 Nucleo-F042 * @defgroup boards_nucleo32-f042 Nucleo32-F042
* @ingroup boards_nucleo * @ingroup boards_nucleo32
* @brief Board specific files for the nucleo32-f042 board * @brief Board specific files for the STM Nucleo32-f042 board
* @{ * @{
* *
* @file * @file

2
boards/nucleo32-f303/include/board.h
View File

@ -8,7 +8,7 @@
/** /**
* @defgroup boards_nucleo32-f303 Nucleo32-F303 * @defgroup boards_nucleo32-f303 Nucleo32-F303
* @ingroup boards_nucleo * @ingroup boards_nucleo32
* @brief Board specific files for the nucleo32-f303 board * @brief Board specific files for the nucleo32-f303 board
* @{ * @{
* *

2
boards/nucleo32-l031/include/board.h
View File

@ -9,7 +9,7 @@
/** /**
* @defgroup boards_nucleo32-l031 Nucleo32-L031 * @defgroup boards_nucleo32-l031 Nucleo32-L031
* @ingroup boards_nucleo * @ingroup boards_nucleo32
* @brief Board specific files for the nucleo32-l031 board * @brief Board specific files for the nucleo32-l031 board
* @{ * @{
* *

2
boards/nucleo32-l432/include/board.h
View File

@ -9,7 +9,7 @@
/** /**
* @defgroup boards_nucleo32-l432 Nucleo32-L432 * @defgroup boards_nucleo32-l432 Nucleo32-L432
* @ingroup boards_nucleo * @ingroup boards_nucleo32
* @brief Board specific files for the nucleo32-l432 board * @brief Board specific files for the nucleo32-l432 board
* @{ * @{
* *