Merge pull request #8189 from smlng/doc/boards_common
Doc: fix and improve doxygen grouping of boards_common
This commit is contained in:
Martine Lenders
GitHub
commit
93ca3345e6
@ -9,7 +9,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_arduino-atmega-common
|
||||
* @ingroup boards_common_arduino-atmega
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_arduino-atmega-common
|
||||
* @ingroup boards_common_arduino-atmega
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_arduino-atmega-common
|
||||
* @ingroup boards_common_arduino-atmega
|
||||
* @{
|
||||
*
|
||||
* @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
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_arduino-atmega-common
|
||||
* @ingroup boards_common_arduino-atmega
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_arduino-atmega-common
|
||||
* @ingroup boards_common_arduino-atmega
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,9 +7,9 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup boards_common_arduino_due Shared Arduino Due Code
|
||||
* @ingroup boards
|
||||
* @brief Shared code for Arduino Due based boards
|
||||
* @defgroup boards_common_arduino_due Arduino Due Common
|
||||
* @ingroup boards_common
|
||||
* @brief Shared files and configuration for Arduino Due based boards.
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -9,12 +9,13 @@
|
||||
|
||||
/**
|
||||
* @ingroup boards_arduino-mkr-common
|
||||
*
|
||||
* @{
|
||||
* @file
|
||||
* @brief Board common implementations for the Arduino MKR boards
|
||||
*
|
||||
* @author Hauke Pertersen <hauke.pertersen@fu-berlin.de>
|
||||
* @author Alexandre Abadie <alexandre.abadie@inria.fr>
|
||||
*
|
||||
* @}
|
||||
*/
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_arduino-mkr1000
|
||||
* @ingroup boards_common_arduino-mkr
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_arduino-mkr-common
|
||||
* @ingroup boards_common_arduino-mkr
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,9 +7,9 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup boards_arduino-mkr-common Arduino MKR Common
|
||||
* @ingroup boards
|
||||
* @brief Support for the Arduino MKR boards type.
|
||||
* @defgroup boards_common_arduino-mkr Arduino MKR Common
|
||||
* @ingroup boards_common
|
||||
* @brief Shared files and configuration for the Arduino MKR boards type.
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_arduino-mkr-common
|
||||
* @ingroup boards_common_arduino-mkr
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_arduino-mkr-common
|
||||
* @ingroup boards_common_arduino-mkr
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
16
boards/common/doc.txt
Normal file
16
boards/common/doc.txt
Normal 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.
|
||||
*/
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup boards_arduino-atmega-common Arduino Atmega Common
|
||||
* @ingroup boards
|
||||
* @brief Common configuration and settings for Arduino Atmega boards
|
||||
* @defgroup boards_common_frdm NXP FRDM Common
|
||||
* @ingroup boards_common
|
||||
* @brief Shared files and configuration for the NXP Freedom Boards.
|
||||
*/
|
||||
@ -7,9 +7,9 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup boards_iotlab-m3 IoT-LAB M3 open node
|
||||
* @ingroup boards
|
||||
* @brief Board specific files for the iotlab-m3 board.
|
||||
* @defgroup boards_common_iotlab IoTlab Common
|
||||
* @ingroup boards_common
|
||||
* @brief Shared files and configuration for the IoTlab boards.
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_iotlab-m3
|
||||
* @ingroup boards_common_iotlab
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_iotlab-m3
|
||||
* @ingroup boards_common_iotlab
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_iotlab-m3
|
||||
* @ingroup boards_common_iotlab
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_iotlab-m3
|
||||
* @ingroup boards_common_iotlab
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -9,15 +9,13 @@
|
||||
/**
|
||||
* @ingroup boards
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @brief msb-430 common board initialization
|
||||
*
|
||||
* @author Oliver Hahm <oliver.hahm@inria.fr>
|
||||
* @author Kaspar Schleiser <kaspar@schleiser.de>
|
||||
*
|
||||
* @}
|
||||
*/
|
||||
|
||||
#include "cpu.h"
|
||||
|
||||
@ -10,7 +10,7 @@
|
||||
#define SHT11_BOARD_H
|
||||
|
||||
/**
|
||||
* @ingroup msb_430h
|
||||
* @ingroup boards_common_msb-430
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
||||
@ -7,9 +7,9 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup boards_msb430-common MSB-430 common
|
||||
* @ingroup boards
|
||||
* @brief Common files for all MSB-430 boards
|
||||
* @defgroup boards_common_msb-430 MSB-430 common
|
||||
* @ingroup boards_common
|
||||
* @brief Shared files and configuration for all MSB-430 boards.
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,11 +7,8 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup msba2
|
||||
* @ingroup boards_common_msba2
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @brief MSB-A2 board initialization
|
||||
*
|
||||
@ -20,6 +17,8 @@
|
||||
* @author Michael Baar <baar@inf.fu-berlin.de>
|
||||
* @author Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
|
||||
* @note $Id$
|
||||
*
|
||||
* @}
|
||||
*/
|
||||
#include <string.h>
|
||||
#include "board.h"
|
||||
|
||||
@ -7,9 +7,9 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup boards_msba2-common MSB-A2 common
|
||||
* @ingroup boards
|
||||
* @brief Common files for all MSB-A2 based boards
|
||||
* @defgroup boards_common_msba2 MSB-A2 common
|
||||
* @ingroup boards_common
|
||||
* @brief Shared files and configuration for all MSB-A2 boards.
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_nrf52840dk
|
||||
* @ingroup boards_common_nrf52
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,9 +7,9 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup boards_common_nrf52 Shared nRF52 code
|
||||
* @defgroup boards_common_nrf52 NRF52 common
|
||||
* @ingroup boards_common
|
||||
* @brief Shared configuration for all nRF52-based boards
|
||||
* @brief Shared files and configuration for all nRF52 boards.
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_nrf52dk
|
||||
* @ingroup boards_common_nrf52
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_nrf52dk
|
||||
* @ingroup boards_common_nrf52
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_nucleo-common
|
||||
* @ingroup boards_common_nucleo
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_nucleo-common
|
||||
* @ingroup boards_common_nucleo
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,15 +7,12 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup boards_nucleo STM Nucleo boards
|
||||
* @defgroup boards_nucleo STM Nucleo Boards
|
||||
* @ingroup boards
|
||||
* @brief STM Nucleo boards
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup boards_nucleo64_common STM Nucleo 64 boards common
|
||||
* @ingroup boards_nucleo
|
||||
* @brief Common files for STM Nucleo 64 boards
|
||||
*
|
||||
* @defgroup boards_common_nucleo STM Nucleo common
|
||||
* @ingroup boards_common
|
||||
* @brief Shared files and configuration for all STM Nucleo boards.
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_nucleo-common
|
||||
* @ingroup boards_common_nucleo
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_nucleo144-common
|
||||
* @ingroup boards_common_nucleo144
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_nucleo144-common
|
||||
* @ingroup boards_common_nucleo144
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -8,9 +8,12 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup boards_nucleo144-common STM Nucleo-144 Common
|
||||
* @ingroup boards_nucleo
|
||||
* @brief Common files for STM Nucleo-144 boards
|
||||
* @defgroup boards_nucleo144 STM Nucleo144 Boards
|
||||
* @ingroup boards
|
||||
*
|
||||
* @defgroup boards_common_nucleo144 STM Nucleo144 common
|
||||
* @ingroup boards_common
|
||||
* @brief Shared files and configuration for all STM Nucleo144 boards.
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_nucleo144-common
|
||||
* @ingroup boards_common_nucleo144
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_nucleo32-common
|
||||
* @ingroup boards_common_nucleo32
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_nucleo32-common
|
||||
* @ingroup boards_common_nucleo32
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,9 +7,12 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup boards_nucleo32-common STM Nucleo-32 Common
|
||||
* @ingroup boards_nucleo
|
||||
* @brief Common files for STM Nucleo-32 boards
|
||||
* @defgroup boards_nucleo32 STM Nucleo32 Boards
|
||||
* @ingroup boards
|
||||
*
|
||||
* @defgroup boards_common_nucleo32 STM Nucleo32 common
|
||||
* @ingroup boards_common
|
||||
* @brief Shared files and configuration for all STM Nucleo32 boards.
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_nucleo32-common
|
||||
* @ingroup boards_common_nucleo32
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -8,8 +8,9 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_remote
|
||||
* @brief Support for the RE-Mote boards
|
||||
* @defgroup boards_common_remote Zolertia Re-Mote common
|
||||
* @ingroup boards_common
|
||||
* @brief Shared files and configuration for all Zolertia Re-Mote boards.
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -8,8 +8,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_remote
|
||||
* @brief LED extension
|
||||
* @ingroup boards_common_remote
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_remote
|
||||
* @ingroup boards_common_remote
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -7,6 +7,18 @@
|
||||
* 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 "irq.h"
|
||||
#include "board.h"
|
||||
|
||||
@ -8,9 +8,9 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup boards_wsn430-common WSN430 common
|
||||
* @ingroup boards
|
||||
* @brief Common files for WSN430 based boards
|
||||
* @defgroup boards_common_wsn430 WSN430 common
|
||||
* @ingroup boards_common
|
||||
* @brief Shared files and configuration for all WSN430 based boards.
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup boards_wsn430-common
|
||||
* @ingroup boards_common_wsn430
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup boards_nucleo144-f207 Nucleo144-F207
|
||||
* @ingroup boards_nucleo
|
||||
* @ingroup boards_nucleo144
|
||||
* @brief Board specific files for the nucleo144-f207 board
|
||||
* @{
|
||||
*
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup boards_nucleo144-f303 Nucleo144-F303
|
||||
* @ingroup boards_nucleo
|
||||
* @ingroup boards_nucleo144
|
||||
* @brief Board specific files for the nucleo144-f303 board
|
||||
* @{
|
||||
*
|
||||
|
||||
@ -8,9 +8,9 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup boards_nucleo144-f412 Nucleo-F412
|
||||
* @ingroup boards_nucleo
|
||||
* @brief Board specific files for the nucleo144-f412 board
|
||||
* @defgroup boards_nucleo144-f412 Nucleo144-F412
|
||||
* @ingroup boards_nucleo144
|
||||
* @brief Board specific files for the STM Nucleo144-f412 board
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -8,9 +8,9 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup boards_nucleo144-f413 Nucleo-F413
|
||||
* @ingroup boards_nucleo
|
||||
* @brief Board specific files for the nucleo144-f413 board
|
||||
* @defgroup boards_nucleo144-f413 Nucleo144-F413
|
||||
* @ingroup boards_nucleo144
|
||||
* @brief Board specific files for the STM Nucleo144-f413 board
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup boards_nucleo144-f429 Nucleo144-F429
|
||||
* @ingroup boards_nucleo
|
||||
* @ingroup boards_nucleo144
|
||||
* @brief Board specific files for the nucleo144-f429 board
|
||||
* @{
|
||||
*
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup boards_nucleo144-f446 Nucleo144-F446
|
||||
* @ingroup boards_nucleo
|
||||
* @ingroup boards_nucleo144
|
||||
* @brief Board specific files for the nucleo144-f446 board
|
||||
* @{
|
||||
*
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup boards_nucleo144-f722 Nucleo144-F722
|
||||
* @ingroup boards
|
||||
* @ingroup boards_nucleo144
|
||||
* @brief Board specific files for the nucleo144-f722 board
|
||||
* @{
|
||||
*
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup boards_nucleo144-f746 Nucleo144-F746
|
||||
* @ingroup boards_nucleo
|
||||
* @ingroup boards_nucleo144
|
||||
* @brief Board specific files for the nucleo144-f746 board
|
||||
* @{
|
||||
*
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup boards_nucleo144-f767 Nucleo144-F767
|
||||
* @ingroup boards_nucleo
|
||||
* @ingroup boards_nucleo144
|
||||
* @brief Board specific files for the nucleo144-f767 board
|
||||
* @{
|
||||
*
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup boards_nucleo32-f031 Nucleo32-F031
|
||||
* @ingroup boards_nucleo
|
||||
* @ingroup boards_nucleo32
|
||||
* @brief Board specific files for the nucleo32-f031 board
|
||||
* @{
|
||||
*
|
||||
|
||||
@ -7,9 +7,9 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup boards_nucleo32-f042 Nucleo-F042
|
||||
* @ingroup boards_nucleo
|
||||
* @brief Board specific files for the nucleo32-f042 board
|
||||
* @defgroup boards_nucleo32-f042 Nucleo32-F042
|
||||
* @ingroup boards_nucleo32
|
||||
* @brief Board specific files for the STM Nucleo32-f042 board
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup boards_nucleo32-f303 Nucleo32-F303
|
||||
* @ingroup boards_nucleo
|
||||
* @ingroup boards_nucleo32
|
||||
* @brief Board specific files for the nucleo32-f303 board
|
||||
* @{
|
||||
*
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup boards_nucleo32-l031 Nucleo32-L031
|
||||
* @ingroup boards_nucleo
|
||||
* @ingroup boards_nucleo32
|
||||
* @brief Board specific files for the nucleo32-l031 board
|
||||
* @{
|
||||
*
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup boards_nucleo32-l432 Nucleo32-L432
|
||||
* @ingroup boards_nucleo
|
||||
* @ingroup boards_nucleo32
|
||||
* @brief Board specific files for the nucleo32-l432 board
|
||||
* @{
|
||||
*
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user