From 882bcff0482ccffc6768d69130fad09827949860 Mon Sep 17 00:00:00 2001 From: Alexandre Abadie <alexandre.abadie@inria.fr> Date: Mon, 10 Apr 2017 19:04:32 +0200 Subject: [PATCH] boards: replace @brief with @name when necessary --- boards/airfy-beacon/include/board.h | 4 +-- boards/airfy-beacon/include/periph_conf.h | 14 +++++----- boards/arduino-atmega-common/include/board.h | 21 ++++++++------- .../include/periph_conf.h | 10 +++---- boards/arduino-due/include/arduino_pinmap.h | 2 +- .../arduino-due/include/sdcard_spi_params.h | 3 +-- boards/arduino-due/include/w5100_params.h | 3 +-- boards/arduino-zero/include/arduino_pinmap.h | 2 +- boards/arduino-zero/include/board.h | 6 ++--- boards/avsextrem/include/board.h | 4 +-- boards/avsextrem/include/periph_conf.h | 10 +++---- boards/calliope-mini/include/board.h | 6 ++--- boards/calliope-mini/include/periph_conf.h | 10 +++---- boards/cc2538dk/include/board.h | 9 +++---- boards/cc2650stk/include/board.h | 6 ++--- boards/cc2650stk/include/periph_conf.h | 6 ++--- boards/chronos/include/board.h | 11 ++++---- boards/chronos/include/periph_conf.h | 14 +++++----- boards/ek-lm4f120xl/include/board.h | 4 +-- boards/f4vi1/include/board.h | 4 +-- boards/f4vi1/include/periph_conf.h | 10 +++---- boards/fox/include/board.h | 18 ++++++++----- boards/fox/include/periph_conf.h | 16 ++++++------ boards/frdm-k64f/include/board.h | 4 +-- boards/iotlab-common/include/board_common.h | 26 +++++++++---------- .../include/periph_conf_common.h | 14 +++++----- boards/limifrog-v1/include/board.h | 4 +-- boards/limifrog-v1/include/periph_conf.h | 12 ++++----- boards/mbed_lpc1768/include/board.h | 4 +-- boards/mbed_lpc1768/include/periph_conf.h | 4 +-- boards/microbit/include/board.h | 10 +++---- boards/microbit/include/periph_conf.h | 2 +- boards/mips-malta/include/periph_conf.h | 10 +++---- boards/msb-430-common/include/board_common.h | 4 +-- boards/msb-430/include/board.h | 5 ++-- boards/msb-430/include/periph_conf.h | 12 ++++----- boards/msb-430h/include/board.h | 5 ++-- boards/msb-430h/include/periph_conf.h | 12 ++++----- boards/msba2/include/board.h | 6 ++--- boards/msba2/include/periph_conf.h | 13 +++++----- boards/msbiot/include/board.h | 8 +++--- boards/msbiot/include/periph_conf.h | 14 +++++----- boards/native/include/board.h | 2 +- boards/nrf52840dk/include/board.h | 6 ++--- boards/nrf52dk/include/board.h | 6 ++--- boards/nrf52dk/include/periph_conf.h | 2 +- boards/nrf6310/include/board.h | 4 +-- boards/nrf6310/include/periph_conf.h | 10 +++---- boards/nucleo-f030/include/board.h | 2 +- boards/nucleo-f070/include/board.h | 2 +- boards/nucleo-f072/include/board.h | 2 +- boards/nucleo-f091/include/board.h | 2 +- boards/nucleo-f103/include/board.h | 2 +- boards/nucleo-f411/include/board.h | 2 +- boards/nucleo-f411/include/periph_conf.h | 16 ++++++------ boards/nucleo-l053/include/board.h | 2 +- boards/nucleo-l053/include/periph_conf.h | 16 ++++++------ boards/nucleo-l073/include/board.h | 2 +- boards/nucleo-l073/include/periph_conf.h | 16 ++++++------ boards/nucleo-l476/include/periph_conf.h | 14 +++++----- .../nucleo144-common/include/board_common.h | 2 +- boards/nucleo144-f207/include/periph_conf.h | 17 ++++++------ boards/nucleo144-f303/include/periph_conf.h | 14 +++++----- boards/nucleo144-f413/include/board.h | 2 +- boards/nucleo144-f413/include/periph_conf.h | 21 +++++++-------- boards/nucleo144-f429/include/board.h | 2 +- boards/nucleo144-f429/include/periph_conf.h | 19 +++++++------- boards/nucleo144-f446/include/board.h | 2 +- boards/nucleo144-f446/include/periph_conf.h | 19 +++++++------- boards/nucleo32-l031/include/periph_conf.h | 17 ++++++------ boards/opencm904/include/board.h | 2 +- boards/openmote-cc2538/include/board.h | 8 +++--- boards/openmote-cc2538/include/periph_conf.h | 12 ++++----- boards/pca10000/include/board.h | 4 +-- boards/pca10000/include/periph_conf.h | 8 +++--- boards/pca10005/include/board.h | 4 +-- boards/pca10005/include/periph_conf.h | 10 +++---- boards/pic32-clicker/include/board.h | 12 ++++----- boards/pic32-clicker/include/periph_conf.h | 18 ++++++------- boards/pic32-wifire/include/board.h | 10 +++---- boards/pic32-wifire/include/periph_conf.h | 8 +++--- boards/qemu-i386/include/board.h | 2 +- boards/remote-pa/include/board.h | 10 ++++--- boards/remote-pa/include/periph_conf.h | 7 +++-- boards/saml21-xpro/include/board.h | 6 ++--- boards/saml21-xpro/include/periph_conf.h | 14 +++++----- boards/samr21-xpro/include/board.h | 10 +++---- boards/samr21-xpro/include/periph_conf.h | 16 ++++++------ boards/seeeduino_arch-pro/include/board.h | 4 +-- .../seeeduino_arch-pro/include/periph_conf.h | 4 +-- boards/slwstk6220a/include/board.h | 8 +++--- boards/slwstk6220a/include/periph_conf.h | 6 ++--- boards/sodaq-autonomo/include/board.h | 6 ++--- boards/sodaq-autonomo/include/periph_conf.h | 16 ++++++------ boards/telosb/include/board.h | 11 ++++---- boards/telosb/include/periph_conf.h | 12 ++++----- boards/udoo/include/board.h | 4 +-- boards/udoo/include/periph_conf.h | 10 +++---- boards/waspmote-pro/include/board.h | 25 +++++++----------- boards/waspmote-pro/include/periph_conf.h | 10 +++---- boards/weio/include/board.h | 4 +-- boards/weio/include/periph_conf.h | 10 +++---- boards/wsn430-common/include/board_common.h | 6 ++--- boards/wsn430-common/include/periph_conf.h | 12 ++++----- boards/wsn430-v1_3b/include/board.h | 5 ++-- boards/wsn430-v1_4/include/board.h | 5 ++-- boards/yunjia-nrf51822/include/board.h | 2 +- boards/z1/include/board.h | 12 ++++----- boards/z1/include/periph_conf.h | 12 ++++----- 109 files changed, 458 insertions(+), 472 deletions(-) diff --git a/boards/airfy-beacon/include/board.h b/boards/airfy-beacon/include/board.h index 1e0687742a..a813dafa1e 100644 --- a/boards/airfy-beacon/include/board.h +++ b/boards/airfy-beacon/include/board.h @@ -28,7 +28,7 @@ #endif /** - * @brief Xtimer configuration + * @name Xtimer configuration * @{ */ #define XTIMER_DEV (0) @@ -38,7 +38,7 @@ /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/airfy-beacon/include/periph_conf.h b/boards/airfy-beacon/include/periph_conf.h index 0d9a1bf566..4831b6b824 100644 --- a/boards/airfy-beacon/include/periph_conf.h +++ b/boards/airfy-beacon/include/periph_conf.h @@ -43,7 +43,7 @@ /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -57,9 +57,9 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name UART configuration + * @name UART configuration * - * The CPU only supports one UART device, so we keep it simple + * The CPU only supports one UART device, so we keep it simple * @{ */ #define UART_NUMOF (1U) @@ -78,7 +78,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * @{ */ static const spi_conf_t spi_config[] = { @@ -94,7 +94,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name I2C (TWI) configuration + * @name I2C (TWI) configuration * @{ */ static const i2c_conf_t i2c_config[] = { @@ -116,7 +116,7 @@ static const i2c_conf_t i2c_config[] = { /** @} */ /** - * @name ADC configuration + * @name ADC configuration * * The configuration consists simply of a list of channels that should be used * @{ @@ -126,7 +126,7 @@ static const i2c_conf_t i2c_config[] = { /** @} */ /** - * @name Radio device configuration + * @name Radio device configuration * * The radio is not guarded by a NUMOF define, as the radio is selected by its * own module in the build system. diff --git a/boards/arduino-atmega-common/include/board.h b/boards/arduino-atmega-common/include/board.h index 256e732d4a..4ac9984b96 100644 --- a/boards/arduino-atmega-common/include/board.h +++ b/boards/arduino-atmega-common/include/board.h @@ -33,15 +33,17 @@ extern "C" { #endif /** - * @brief As the CPU is too slow to handle 115200 baud, we set the default - * baudrate to 9600 for this board + * @name STDIO configuration + * + * As the CPU is too slow to handle 115200 baud, we set the default + * baudrate to 9600 for this board * @{ */ #define UART_STDIO_BAUDRATE (9600U) /** @} */ /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #ifdef CPU_ATMEGA328P @@ -60,10 +62,11 @@ extern "C" { /** @} */ /** - ** Context swap defines - ** Setup to use PC5 which is pin change interrupt 13 (PCINT13) - ** This emulates a software triggered interrupt - ***/ + * @brief Context swap defines + * + * Setup to use PC5 which is pin change interrupt 13 (PCINT13) + * This emulates a software triggered interrupt + */ #ifdef CPU_ATMEGA328P #define AVR_CONTEXT_SWAP_INIT do { \ DDRC |= (1 << PC5); \ @@ -85,7 +88,7 @@ extern "C" { #endif /** - * @brief xtimer configuration values + * @name xtimer configuration values * @{ */ #define XTIMER_WIDTH (16) @@ -95,7 +98,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/arduino-atmega-common/include/periph_conf.h b/boards/arduino-atmega-common/include/periph_conf.h index a485208392..2f3c9e2c06 100644 --- a/boards/arduino-atmega-common/include/periph_conf.h +++ b/boards/arduino-atmega-common/include/periph_conf.h @@ -28,14 +28,14 @@ extern "C" { #endif /** - * @brief Clock configuration + * @name Clock configuration * @{ */ #define CLOCK_CORECLOCK (16000000L) /** @} */ /** - * @name Timer configuration + * @name Timer configuration * * arduino uno and arduino duemilanove: * The timer driver only supports the 16-bit timer (Timer1) @@ -74,12 +74,10 @@ extern "C" { #define TIMER_1_ISRB TIMER4_COMPB_vect #define TIMER_1_ISRC TIMER4_COMPC_vect #endif - - /** @} */ /** - * @name UART configuration + * @name UART configuration * * The UART devices have fixed pin mappings, so all we need to do, is to specify * which devices we would like to use and their corresponding RX interrupts. See @@ -112,7 +110,7 @@ extern "C" { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * * The atmega2560 has only one hardware SPI with fixed pin configuration, so all * we can do here, is to enable or disable it... diff --git a/boards/arduino-due/include/arduino_pinmap.h b/boards/arduino-due/include/arduino_pinmap.h index 2ce455bc29..85f080bd38 100644 --- a/boards/arduino-due/include/arduino_pinmap.h +++ b/boards/arduino-due/include/arduino_pinmap.h @@ -29,7 +29,7 @@ extern "C" { #endif /** - * @brief Mapping of MCU pins to Arduino pins + * @name Mapping of MCU pins to Arduino pins * @{ */ #define ARDUINO_PIN_0 GPIO_PIN(PA, 8) diff --git a/boards/arduino-due/include/sdcard_spi_params.h b/boards/arduino-due/include/sdcard_spi_params.h index 0cd2a1e4c1..cd3c77eb2b 100644 --- a/boards/arduino-due/include/sdcard_spi_params.h +++ b/boards/arduino-due/include/sdcard_spi_params.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @brief Set default configuration parameters for the sdcard_spi driver + * @name Default configuration for the sdcard_spi driver * @{ */ #ifndef SDCARD_SPI_PARAM_SPI @@ -69,7 +69,6 @@ static const sdcard_spi_params_t sdcard_spi_params[] = { .power_act_high = SDCARD_SPI_PARAM_POWER_AH }, }; -/** @} */ #ifdef __cplusplus } diff --git a/boards/arduino-due/include/w5100_params.h b/boards/arduino-due/include/w5100_params.h index 7eefa13bad..fbd550fa85 100644 --- a/boards/arduino-due/include/w5100_params.h +++ b/boards/arduino-due/include/w5100_params.h @@ -24,7 +24,7 @@ extern "C" { #endif /** - * @brief Set configuration parameters for the W5100 driver + * @name Configuration parameters for the W5100 driver * @{ */ #ifndef W5100_PARAM_SPI @@ -52,7 +52,6 @@ static const w5100_params_t w5100_params[] = { .evt = W5100_PARAM_EVT }, }; -/** @} */ #ifdef __cplusplus } diff --git a/boards/arduino-zero/include/arduino_pinmap.h b/boards/arduino-zero/include/arduino_pinmap.h index 02a4f22136..77d7310fbb 100644 --- a/boards/arduino-zero/include/arduino_pinmap.h +++ b/boards/arduino-zero/include/arduino_pinmap.h @@ -29,7 +29,7 @@ extern "C" { #endif /** - * @brief Mapping of MCU pins to Arduino pins + * @name Mapping of MCU pins to Arduino pins * @{ */ #define ARDUINO_PIN_0 GPIO_PIN(PA, 11) diff --git a/boards/arduino-zero/include/board.h b/boards/arduino-zero/include/board.h index 753ca5c1be..c4ba1c9f8d 100644 --- a/boards/arduino-zero/include/board.h +++ b/boards/arduino-zero/include/board.h @@ -32,7 +32,7 @@ extern "C" { #endif /** - * @brief xtimer configuration + * @name xtimer configuration * @{ */ #define XTIMER TIMER_0 @@ -40,7 +40,7 @@ extern "C" { /** @} */ /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(PA, 17) @@ -54,7 +54,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/avsextrem/include/board.h b/boards/avsextrem/include/board.h index 3fe0fe6bfd..81c523c728 100644 --- a/boards/avsextrem/include/board.h +++ b/boards/avsextrem/include/board.h @@ -32,7 +32,7 @@ extern "C" { #endif /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(2, 25) @@ -51,7 +51,7 @@ extern "C" { /** @} */ /** - * @brief Initialize the board's clock system + * @brief Initialize the board's clock system */ void init_clks1(void); diff --git a/boards/avsextrem/include/periph_conf.h b/boards/avsextrem/include/periph_conf.h index 15a7bccbb4..a0851e9ddb 100644 --- a/boards/avsextrem/include/periph_conf.h +++ b/boards/avsextrem/include/periph_conf.h @@ -26,7 +26,7 @@ extern "C" { #endif /** - * @name Clock configuration + * @name Clock configuration * @{ */ #define CLOCK_CORECLOCK (72000000U) /* this board runs with 72MHz */ @@ -35,20 +35,20 @@ extern "C" { /** @} */ /** - * @name Timer configuration, select a number from 1 to 4 + * @name Timer configuration, select a number from 1 to 4 * @{ */ #define TIMER_NUMOF (1U) /** @} */ /** - * @name Real Time Clock configuration + * @name Real Time Clock configuration */ #define RTC_NUMOF (1U) /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ #define UART_NUMOF (1U) @@ -56,7 +56,7 @@ extern "C" { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * @{ */ #define SPI_NUMOF (1U) diff --git a/boards/calliope-mini/include/board.h b/boards/calliope-mini/include/board.h index f9036e4331..aa890627da 100644 --- a/boards/calliope-mini/include/board.h +++ b/boards/calliope-mini/include/board.h @@ -29,7 +29,7 @@ extern "C" { #endif /** - * @brief Xtimer configuration + * @name Xtimer configuration * @{ */ #define XTIMER_DEV (0) @@ -39,7 +39,7 @@ extern "C" { /** @} */ /** - * @brief LED matrix pin configuration + * @name LED matrix pin configuration * @{ */ #define MINI_LED_COL1 GPIO_PIN(0, 4) @@ -57,7 +57,7 @@ extern "C" { /** @} */ /** - * @brief Button configuration + * @name Button configuration * @{ */ #define BTN0_PIN GPIO_PIN(0, 17) diff --git a/boards/calliope-mini/include/periph_conf.h b/boards/calliope-mini/include/periph_conf.h index c9146207d4..4680d07cb3 100644 --- a/boards/calliope-mini/include/periph_conf.h +++ b/boards/calliope-mini/include/periph_conf.h @@ -42,7 +42,7 @@ extern "C" { /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -84,7 +84,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ #define UART_NUMOF (1U) @@ -95,7 +95,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name I2C (TWI) configuration + * @name I2C (TWI) configuration * @{ */ static const i2c_conf_t i2c_config[] = { @@ -111,7 +111,7 @@ static const i2c_conf_t i2c_config[] = { /** @} */ /** - * @name ADC configuration + * @name ADC configuration * * The configuration consists simply of a list of channels that should be used * @{ @@ -120,7 +120,7 @@ static const i2c_conf_t i2c_config[] = { /** @} */ /** - * @brief Radio device configuration + * @name Radio device configuration * * The radio is not guarded by a NUMOF define, as the radio is selected by its * own module in the build system. diff --git a/boards/cc2538dk/include/board.h b/boards/cc2538dk/include/board.h index d0dcc5dacc..c8bb164785 100644 --- a/boards/cc2538dk/include/board.h +++ b/boards/cc2538dk/include/board.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(2, 0) @@ -60,10 +60,9 @@ extern "C" { /** @} */ /** - * @name Flash Customer Configuration Area (CCA) parameters + * @name Flash Customer Configuration Area (CCA) parameters * @{ */ - #ifndef UPDATE_CCA #define UPDATE_CCA 1 #endif @@ -74,7 +73,7 @@ extern "C" { /** @} */ /** - * @name xtimer configuration + * @name xtimer configuration * @{ */ #define XTIMER_DEV (0) @@ -87,7 +86,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/cc2650stk/include/board.h b/boards/cc2650stk/include/board.h index 92be45b500..a265863f23 100644 --- a/boards/cc2650stk/include/board.h +++ b/boards/cc2650stk/include/board.h @@ -28,14 +28,14 @@ extern "C" { #endif /** - * @brief Xtimer configuration + * @name Xtimer configuration * @{ */ #define XTIMER_WIDTH (16) /** @} */ /** - * @brief On-board button configuration + * @name On-board button configuration * @{ */ #define BUTTON1_DIO GPIO_PIN(0, 4) @@ -43,7 +43,7 @@ extern "C" { /** @} */ /** - * @brief Macros for controlling the on-board LEDs + * @name Macros for controlling the on-board LEDs * @{ */ #define LED0_PIN GPIO_PIN(0, 10) diff --git a/boards/cc2650stk/include/periph_conf.h b/boards/cc2650stk/include/periph_conf.h index 6b15cf4394..d502f3111a 100644 --- a/boards/cc2650stk/include/periph_conf.h +++ b/boards/cc2650stk/include/periph_conf.h @@ -26,7 +26,7 @@ extern "C" { #endif /** - * @brief Clock configuration + * @name Clock configuration * @{ */ /* the main clock is fixed to 48MHZ */ @@ -34,7 +34,7 @@ extern "C" { /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -55,7 +55,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name UART configuration + * @name UART configuration * * The used CC26x0 CPU only supports a single UART device, so all we need to * configure are the RX and TX pins. diff --git a/boards/chronos/include/board.h b/boards/chronos/include/board.h index 01cb494de6..dce97b73ad 100644 --- a/boards/chronos/include/board.h +++ b/boards/chronos/include/board.h @@ -15,7 +15,7 @@ * @file * @brief Header for the chronos board * - * @author unknwon + * @author unknown */ #ifndef CHRONOS_BOARD_H @@ -28,14 +28,14 @@ extern "C" { #endif /** - * @brief Define the CPU model for the <msp430.h> + * @name Define the CPU model for the <msp430.h> */ #ifndef __CC430F6137__ #define __CC430F6137__ #endif /** - * @brief Xtimer configuration + * @name Xtimer configuration * @{ */ #define XTIMER_DEV (0) @@ -44,9 +44,10 @@ extern "C" { /** @} */ /** - * @brief MSP430 core configuration + * @name MSP430 core configuration * @{ */ +/** @todo Move this to the periph_conf.h */ #define MSP430_INITIAL_CPU_SPEED 7372800uL #define F_CPU MSP430_INITIAL_CPU_SPEED #define F_RC_OSCILLATOR 32768 @@ -58,5 +59,5 @@ extern "C" { } #endif -#endif /* _CHRONOS_BOARD_H */ +#endif /* CHRONOS_BOARD_H */ /** @} */ diff --git a/boards/chronos/include/periph_conf.h b/boards/chronos/include/periph_conf.h index aad43225f3..1f777acd8c 100644 --- a/boards/chronos/include/periph_conf.h +++ b/boards/chronos/include/periph_conf.h @@ -26,17 +26,17 @@ extern "C" { #endif /** - * @brief Clock configuration - * - * @todo Move all clock configuration code here from the board.h + * @name Clock configuration + * @{ */ +/** @todo Move all clock configuration code here from the board.h */ #define CLOCK_CORECLOCK (12000000U) #define CLOCK_CMCLK CLOCK_CORECLOCK /* no divider programmed */ /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ #define TIMER_NUMOF (1U) @@ -47,7 +47,7 @@ extern "C" { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ #define UART_NUMOF (1U) @@ -68,9 +68,11 @@ extern "C" { /** @} */ /** - * @brief Real Time Clock configuration + * @name Real Time Clock configuration + * @{ */ #define RTC_NUMOF (1) +/** @} */ #ifdef __cplusplus } diff --git a/boards/ek-lm4f120xl/include/board.h b/boards/ek-lm4f120xl/include/board.h index 5a69618d65..118be9dca3 100644 --- a/boards/ek-lm4f120xl/include/board.h +++ b/boards/ek-lm4f120xl/include/board.h @@ -30,7 +30,7 @@ extern "C" { #endif /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(5, 7) @@ -56,7 +56,7 @@ extern "C" { /* @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ extern void board_init(void); diff --git a/boards/f4vi1/include/board.h b/boards/f4vi1/include/board.h index 28ac4932dc..6296a0e5b0 100644 --- a/boards/f4vi1/include/board.h +++ b/boards/f4vi1/include/board.h @@ -30,7 +30,7 @@ extern "C" { #endif /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(PORT_A, 1) @@ -56,7 +56,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/f4vi1/include/periph_conf.h b/boards/f4vi1/include/periph_conf.h index a3b524d365..eca25a7f68 100644 --- a/boards/f4vi1/include/periph_conf.h +++ b/boards/f4vi1/include/periph_conf.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @name Clock system configuration + * @name Clock system configuration * @{ */ #define CLOCK_HSE (16000000U) /* external oscillator */ @@ -51,7 +51,7 @@ extern "C" { /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -78,7 +78,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ static const uart_conf_t uart_config[] = { @@ -105,14 +105,14 @@ static const uart_conf_t uart_config[] = { /** @} */ /** - * @name ADC configuration + * @name ADC configuration * @{ */ #define ADC_NUMOF (0) /** @} */ /** - * @name DAC configuration + * @name DAC configuration * @{ */ #define DAC_NUMOF (0) diff --git a/boards/fox/include/board.h b/boards/fox/include/board.h index d87e492d07..bac3ecefc9 100644 --- a/boards/fox/include/board.h +++ b/boards/fox/include/board.h @@ -34,12 +34,16 @@ extern "C" { #endif /** - * @name Tell the xtimer that we use a 16-bit peripheral timer + * @name Xtimer configuration + * + * Tell the xtimer that we use a 16-bit peripheral timer + * @{ */ #define XTIMER_WIDTH (16) +/** @} */ /** - * @name Define the interface to the AT86RF231 radio + * @brief Define the interface to the AT86RF231 radio * * {spi bus, spi speed, cs pin, int pin, reset pin, sleep pin} */ @@ -51,7 +55,7 @@ extern "C" { .reset_pin = GPIO_PIN(PORT_C, 1)} /** - * @name Define the interface to the LPS331AP pressure sensor + * @name Define the interface to the LPS331AP pressure sensor * @{ */ #define LPS331AP_I2C I2C_0 @@ -59,7 +63,7 @@ extern "C" { /** @} */ /** - * @name Define the interface for the L3G4200D gyroscope + * @name Define the interface for the L3G4200D gyroscope * @{ */ #define L3G4200D_I2C I2C_0 @@ -69,7 +73,7 @@ extern "C" { /** @} */ /** - * @name Define the interface to the LSM303DLHC accelerometer and magnetometer + * @name Define the interface to the LSM303DLHC accelerometer and magnetometer * @{ */ #define LSM303DLHC_I2C I2C_0 @@ -81,7 +85,7 @@ extern "C" { /** @} */ /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(PORT_B, 10) @@ -100,7 +104,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/fox/include/periph_conf.h b/boards/fox/include/periph_conf.h index 65c3e24613..b2893ac7ea 100644 --- a/boards/fox/include/periph_conf.h +++ b/boards/fox/include/periph_conf.h @@ -26,7 +26,7 @@ extern "C" { #endif /** - * @name Clock system configuration + * @name Clock system configuration * @{ **/ #define CLOCK_HSE (16000000U) /* frequency of external oscillator */ @@ -45,21 +45,21 @@ extern "C" { /** @} */ /** - * @name ADC configuration + * @name ADC configuration * @{ */ #define ADC_NUMOF (0) /** @} */ /** - * @name DAC configuration + * @name DAC configuration * @{ */ #define DAC_NUMOF (0) /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -86,7 +86,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ static const uart_conf_t uart_config[] = { @@ -115,7 +115,7 @@ static const uart_conf_t uart_config[] = { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * * @note The spi_divtable is auto-generated from * `cpu/stm32_common/dist/spi_divtable/spi_divtable.c` @@ -154,7 +154,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name Real time counter configuration + * @name Real time counter configuration * @{ */ #define RTT_NUMOF (1U) @@ -169,7 +169,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name I2C configuration + * @name I2C configuration * @{ */ #define I2C_NUMOF (1U) diff --git a/boards/frdm-k64f/include/board.h b/boards/frdm-k64f/include/board.h index c9fcd2faef..08e5a5e22e 100644 --- a/boards/frdm-k64f/include/board.h +++ b/boards/frdm-k64f/include/board.h @@ -31,7 +31,7 @@ extern "C" #endif /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(PORT_B, 22) @@ -56,7 +56,7 @@ extern "C" /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/iotlab-common/include/board_common.h b/boards/iotlab-common/include/board_common.h index f0161d7b84..3ff17b1ed6 100644 --- a/boards/iotlab-common/include/board_common.h +++ b/boards/iotlab-common/include/board_common.h @@ -35,7 +35,7 @@ extern "C" { #endif /** - * @name Set the default baudrate to 500K for this board + * @name Set the default baudrate to 500K for this board * @{ */ #ifndef UART_STDIO_BAUDRATE @@ -44,12 +44,18 @@ extern "C" { /** @} */ /** - * @name Tell the xtimer that we use a 16-bit peripheral timer + * @name Xtimer configuration + * + * Tell the xtimer that we use a 16-bit peripheral timer + * @{ */ -#define XTIMER_WIDTH (16) +#define XTIMER_WIDTH (16U) +#define XTIMER_OVERHEAD (6U) +#define XTIMER_SHOOT_EARLY (3U) +/** @} */ /** - * @name Define the interface to the AT86RF231 radio + * @brief Define the interface to the AT86RF231 radio * * {spi bus, spi speed, cs pin, int pin, reset pin, sleep pin} */ @@ -61,7 +67,7 @@ extern "C" { .reset_pin = GPIO_PIN(PORT_C, 1)} /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(PORT_D, 2) @@ -86,15 +92,7 @@ extern "C" { /** @} */ /** - * @name xtimer tuning values - * @{ - */ -#define XTIMER_OVERHEAD 6 -#define XTIMER_SHOOT_EARLY 3 -/** @} */ - -/** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/iotlab-common/include/periph_conf_common.h b/boards/iotlab-common/include/periph_conf_common.h index 0e5f556a93..6c39347d25 100644 --- a/boards/iotlab-common/include/periph_conf_common.h +++ b/boards/iotlab-common/include/periph_conf_common.h @@ -27,7 +27,7 @@ extern "C" { #endif /** - * @name Clock system configuration + * @name Clock system configuration * @{ **/ #define CLOCK_HSE (16000000U) /* frequency of external oscillator */ @@ -48,7 +48,7 @@ extern "C" { /** @} */ /** - * @name ADC configuration + * @name ADC configuration * @{ */ #define ADC_CONFIG { \ @@ -60,7 +60,7 @@ extern "C" { /** @} */ /** - * @brief Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -87,7 +87,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @brief UART configuration + * @name UART configuration * @{ */ static const uart_conf_t uart_config[] = { @@ -116,14 +116,14 @@ static const uart_conf_t uart_config[] = { /** @} */ /** - * @name DAC configuration + * @name DAC configuration * @{ */ #define DAC_NUMOF (0) /** @} */ /** - * @name Real time counter configuration + * @name Real time counter configuration * @{ */ #define RTT_NUMOF (1U) @@ -138,7 +138,7 @@ static const uart_conf_t uart_config[] = { /** @} */ /** - * @name I2C configuration + * @name I2C configuration * @{ */ #define I2C_NUMOF (1U) diff --git a/boards/limifrog-v1/include/board.h b/boards/limifrog-v1/include/board.h index 8b2900a137..5a77a8b483 100644 --- a/boards/limifrog-v1/include/board.h +++ b/boards/limifrog-v1/include/board.h @@ -31,7 +31,7 @@ extern "C" { #endif /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(PORT_C, 3) @@ -45,7 +45,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/limifrog-v1/include/periph_conf.h b/boards/limifrog-v1/include/periph_conf.h index 0762a4b847..ca761b300d 100644 --- a/boards/limifrog-v1/include/periph_conf.h +++ b/boards/limifrog-v1/include/periph_conf.h @@ -26,7 +26,7 @@ extern "C" { #endif /** - * @name Clock system configuration + * @name Clock system configuration * @{ **/ #define CLOCK_HSI (16000000U) /* internal oscillator */ @@ -50,14 +50,14 @@ extern "C" { /** @} */ /** - * @name DAC configuration + * @name DAC configuration * @{ */ #define DAC_NUMOF (0) /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -76,7 +76,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ static const uart_conf_t uart_config[] = { @@ -109,7 +109,7 @@ static const uart_conf_t uart_config[] = { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * * @note The spi_divtable is auto-generated from * `cpu/stm32_common/dist/spi_divtable/spi_divtable.c` @@ -159,7 +159,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name I2C configuration + * @name I2C configuration * @{ */ #define I2C_0_EN 1 diff --git a/boards/mbed_lpc1768/include/board.h b/boards/mbed_lpc1768/include/board.h index 3cd14468c7..473b291a9f 100644 --- a/boards/mbed_lpc1768/include/board.h +++ b/boards/mbed_lpc1768/include/board.h @@ -33,7 +33,7 @@ extern "C" { #endif /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(1, 18) @@ -62,7 +62,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, include clocks, LEDs and stdio + * @brief Initialize board specific hardware, include clocks, LEDs and stdio */ void board_init(void); diff --git a/boards/mbed_lpc1768/include/periph_conf.h b/boards/mbed_lpc1768/include/periph_conf.h index 4240ff0c87..ccefcedcfb 100644 --- a/boards/mbed_lpc1768/include/periph_conf.h +++ b/boards/mbed_lpc1768/include/periph_conf.h @@ -24,7 +24,7 @@ extern "C" { #endif /** - * @name Timer configuration + * @name Timer configuration * @{ */ #define TIMER_NUMOF (1U) @@ -44,7 +44,7 @@ extern "C" { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ #define UART_NUMOF (2U) diff --git a/boards/microbit/include/board.h b/boards/microbit/include/board.h index befff51bb1..61551cdf5c 100644 --- a/boards/microbit/include/board.h +++ b/boards/microbit/include/board.h @@ -29,7 +29,7 @@ extern "C" { #endif /** - * @brief Xtimer configuration + * @name Xtimer configuration * @{ */ #define XTIMER_DEV (0) @@ -39,7 +39,7 @@ extern "C" { /** @} */ /** - * @brief LED matrix pin configuration + * @name LED matrix pin configuration * @{ */ #define MICROBIT_LED_COL1 GPIO_PIN(0, 4) @@ -57,7 +57,7 @@ extern "C" { /** @} */ /** - * @brief Button configuration + * @name Button configuration * @{ */ #define BTN0_PIN GPIO_PIN(0, 17) @@ -65,7 +65,7 @@ extern "C" { /** @} */ /** - * @brief MMA8653 accelerometer configuration + * @name MMA8653 accelerometer configuration * @{ */ #define MMA8653_PARAM_I2C I2C_0, @@ -73,7 +73,7 @@ extern "C" { /** @} */ /** - * @brief MAG3110 magnetometer configuration + * @name MAG3110 magnetometer configuration * @{ */ #define MAG3110_PARAM_I2C I2C_0, diff --git a/boards/microbit/include/periph_conf.h b/boards/microbit/include/periph_conf.h index f6dbb2e618..804a0cf226 100644 --- a/boards/microbit/include/periph_conf.h +++ b/boards/microbit/include/periph_conf.h @@ -120,7 +120,7 @@ static const i2c_conf_t i2c_config[] = { /** @} */ /** - * @brief Radio device configuration + * @name Radio device configuration * * The radio is not guarded by a NUMOF define, as the radio is selected by its * own module in the build system. diff --git a/boards/mips-malta/include/periph_conf.h b/boards/mips-malta/include/periph_conf.h index d8dad5660d..22af279c8b 100644 --- a/boards/mips-malta/include/periph_conf.h +++ b/boards/mips-malta/include/periph_conf.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @brief Timer definitions + * @name Timer definitions * @{ */ #define TIMER_NUMOF (1) @@ -36,18 +36,18 @@ extern "C" { /** @} */ /** - * @brief No UART driver for this board currently - * Note this value must be set though (to 0) + * @brief No UART driver for this board currently + * Note this value must be set though (to 0) */ #define UART_NUMOF (0) /** - * @brief Enable DSP context save + restore. + * @brief Enable DSP context save + restore. */ #define MIPS_DSP (1) /** - * @brief Enable FPU context save + restore. + * @brief Enable FPU context save + restore. */ #define MIPS_HARD_FLOAT (1) diff --git a/boards/msb-430-common/include/board_common.h b/boards/msb-430-common/include/board_common.h index c7e731fac4..26c76d3919 100644 --- a/boards/msb-430-common/include/board_common.h +++ b/boards/msb-430-common/include/board_common.h @@ -34,7 +34,7 @@ extern "C" { #define INFOMEM (0x1000) /** - * @brief Xtimer configuration + * @name Xtimer configuration * @{ */ #define XTIMER_DEV (0) @@ -44,7 +44,7 @@ extern "C" { /** @} */ /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(4, 7) diff --git a/boards/msb-430/include/board.h b/boards/msb-430/include/board.h index a2e6a9b3cc..c9372e09e3 100644 --- a/boards/msb-430/include/board.h +++ b/boards/msb-430/include/board.h @@ -48,11 +48,10 @@ extern "C" { #endif /** - * @brief CPU core configuration - * - * @todo Move this to the periph_conf.h + * @name CPU core configuration * @{ */ +/** @todo Move this to the periph_conf.h */ #define MSP430_INITIAL_CPU_SPEED 2457600uL #define F_CPU MSP430_INITIAL_CPU_SPEED #define F_RC_OSCILLATOR 32768 diff --git a/boards/msb-430/include/periph_conf.h b/boards/msb-430/include/periph_conf.h index 1026d73e58..d6d05f1e23 100644 --- a/boards/msb-430/include/periph_conf.h +++ b/boards/msb-430/include/periph_conf.h @@ -26,17 +26,17 @@ extern "C" { #endif /** - * @brief Clock configuration - * - * @todo Move all clock configuration code here from the board.h + * @name Clock configuration + * @{ */ +/** @todo Move all clock configuration code here from the board.h */ #define CLOCK_CORECLOCK (7372800U) #define CLOCK_CMCLK CLOCK_CORECLOCK /* no divider programmed */ /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ #define TIMER_NUMOF (1U) @@ -47,7 +47,7 @@ extern "C" { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ #define UART_NUMOF (1U) @@ -68,7 +68,7 @@ extern "C" { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * @{ */ #define SPI_NUMOF (1U) diff --git a/boards/msb-430h/include/board.h b/boards/msb-430h/include/board.h index 72ea980dc6..6d6f1cbe83 100644 --- a/boards/msb-430h/include/board.h +++ b/boards/msb-430h/include/board.h @@ -36,11 +36,10 @@ extern "C" { #endif /** - * @brief CPU core configuration - * - * @todo Move this to the periph_conf.h + * @name CPU core configuration * @{ */ +/** @todo Move this to the periph_conf.h */ #define MSP430_INITIAL_CPU_SPEED 7372800uL #define F_CPU MSP430_INITIAL_CPU_SPEED #define F_RC_OSCILLATOR 32768 diff --git a/boards/msb-430h/include/periph_conf.h b/boards/msb-430h/include/periph_conf.h index 69b52c709f..a1cd85b5e6 100644 --- a/boards/msb-430h/include/periph_conf.h +++ b/boards/msb-430h/include/periph_conf.h @@ -28,17 +28,17 @@ extern "C" { #endif /** - * @brief Clock configuration - * - * @todo Move all clock configuration code here from the board.h + * @name Clock configuration + * @{ */ +/** @todo Move all clock configuration code here from the board.h */ #define CLOCK_CORECLOCK (7372800U) #define CLOCK_CMCLK CLOCK_CORECLOCK /* no divider programmed */ /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ #define TIMER_NUMOF (1U) @@ -49,7 +49,7 @@ extern "C" { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ #define UART_NUMOF (1U) @@ -70,7 +70,7 @@ extern "C" { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * @{ */ #define SPI_NUMOF (1U) diff --git a/boards/msba2/include/board.h b/boards/msba2/include/board.h index 5f3840ba41..379b1e1f08 100644 --- a/boards/msba2/include/board.h +++ b/boards/msba2/include/board.h @@ -29,7 +29,7 @@ extern "C" { #endif /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(2, 25) @@ -48,7 +48,7 @@ extern "C" { /** @} */ /** - * @name xtimer tuning values + * @name xtimer tuning values * @{ */ #define XTIMER_OVERHEAD 7 @@ -56,7 +56,7 @@ extern "C" { /** @} */ /** - * @brief initialize the board's clock system + * @brief initialize the board's clock system */ void init_clks1(void); diff --git a/boards/msba2/include/periph_conf.h b/boards/msba2/include/periph_conf.h index 5dcb6a20ed..b0a9e66692 100644 --- a/boards/msba2/include/periph_conf.h +++ b/boards/msba2/include/periph_conf.h @@ -26,7 +26,7 @@ extern "C" { #endif /** - * @brief Clock configuration + * @name Clock configuration * @{ */ #define CLOCK_CORECLOCK (72000000U) /* the msba2 runs with 72MHz */ @@ -35,7 +35,7 @@ extern "C" { /** @} */ /** - * @name Timer configuration, select a number from 1 to 4 + * @name Timer configuration, select a number from 1 to 4 * @{ */ #define TIMER_NUMOF (1U) @@ -46,7 +46,6 @@ extern "C" { * * Currently, we only support a single device and 3 channels, the implementation * is fixed on PWM1. - * * @{ */ #define PWM_NUMOF (1U) @@ -68,12 +67,14 @@ extern "C" { /** @} */ /** - * @brief Real Time Clock configuration + * @name Real Time Clock configuration + * @{ */ #define RTC_NUMOF (1) +/** @} */ /** - * @brief uart configuration + * @name UART configuration * @{ */ #define UART_NUMOF (1) @@ -81,7 +82,7 @@ extern "C" { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * * The SPI implementation is very much fixed, so we don't need to configure * anything besides the mandatory SPI_NUMOF. diff --git a/boards/msbiot/include/board.h b/boards/msbiot/include/board.h index 89bfa583a4..2f34317b4c 100644 --- a/boards/msbiot/include/board.h +++ b/boards/msbiot/include/board.h @@ -29,7 +29,7 @@ extern "C" { #endif /** - * @name Configure connected CC1101 (radio) device + * @name Configure connected CC1101 (radio) device * @{ */ #define CC110X_SPI SPI_DEV(0) @@ -40,7 +40,7 @@ extern "C" { /** @} */ /** - * @name Configure connected MPU-9150 device + * @name Configure connected MPU-9150 device * @{ */ #define MPU9150_I2C I2C_0 @@ -49,7 +49,7 @@ extern "C" { /** @} */ /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(PORT_B, 8) @@ -75,7 +75,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/msbiot/include/periph_conf.h b/boards/msbiot/include/periph_conf.h index 2dda1f35af..eeb4bdf37a 100644 --- a/boards/msbiot/include/periph_conf.h +++ b/boards/msbiot/include/periph_conf.h @@ -26,7 +26,7 @@ extern "C" { #endif /** - * @name Clock system configuration + * @name Clock system configuration * @{ */ #define CLOCK_HSE (16000000U) /* external oscillator */ @@ -49,7 +49,7 @@ extern "C" { /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -96,7 +96,7 @@ static const pwm_conf_t pwm_config[] = { /** @} */ /** - * @name ADC configuration + * @name ADC configuration * * We need to define the following fields: * PIN, device (ADCx), channel @@ -111,7 +111,7 @@ static const pwm_conf_t pwm_config[] = { /** @} */ /** - * @name DAC configuration + * @name DAC configuration * * We need to define the following fields: * PIN, DAC channel @@ -126,7 +126,7 @@ static const pwm_conf_t pwm_config[] = { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ static const uart_conf_t uart_config[] = { @@ -187,7 +187,7 @@ static const uart_conf_t uart_config[] = { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * * @note The spi_divtable is auto-generated from * `cpu/stm32_common/dist/spi_divtable/spi_divtable.c` @@ -227,7 +227,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name I2C configuration + * @name I2C configuration * @{ */ #define I2C_NUMOF (1U) diff --git a/boards/native/include/board.h b/boards/native/include/board.h index 84d66cdad3..967e258e91 100644 --- a/boards/native/include/board.h +++ b/boards/native/include/board.h @@ -35,7 +35,7 @@ extern "C" { #endif /** - * @brief LED handlers + * @name LED handlers * @{ */ void _native_LED_GREEN_OFF(void); diff --git a/boards/nrf52840dk/include/board.h b/boards/nrf52840dk/include/board.h index 8d79d5482c..c9c0ce4997 100644 --- a/boards/nrf52840dk/include/board.h +++ b/boards/nrf52840dk/include/board.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @brief LED pin configuration + * @name LED pin configuration * @{ */ #define LED0_PIN GPIO_PIN(0, 13) @@ -60,7 +60,7 @@ extern "C" { /** @} */ /** - * @brief Button pin configuration + * @name Button pin configuration * @{ */ #define BUTTON1_PIN (GPIO_PIN(0, 11)) @@ -70,7 +70,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/nrf52dk/include/board.h b/boards/nrf52dk/include/board.h index 48d3447d5d..6550dee0f9 100644 --- a/boards/nrf52dk/include/board.h +++ b/boards/nrf52dk/include/board.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @brief LED pin configuration + * @name LED pin configuration * @{ */ #define LED0_PIN GPIO_PIN(0, 17) @@ -59,7 +59,7 @@ extern "C" { /** @} */ /** - * @brief Button pin configuration + * @name Button pin configuration * @{ */ #define BUTTON1_PIN (GPIO_PIN(0, 13)) @@ -69,7 +69,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/nrf52dk/include/periph_conf.h b/boards/nrf52dk/include/periph_conf.h index 0e86125f84..96c46616f1 100644 --- a/boards/nrf52dk/include/periph_conf.h +++ b/boards/nrf52dk/include/periph_conf.h @@ -42,7 +42,7 @@ extern "C" { /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { diff --git a/boards/nrf6310/include/board.h b/boards/nrf6310/include/board.h index bc5dad8964..5c3b9b163f 100644 --- a/boards/nrf6310/include/board.h +++ b/boards/nrf6310/include/board.h @@ -30,7 +30,7 @@ extern "C" { #endif /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(0, 8) @@ -55,7 +55,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/nrf6310/include/periph_conf.h b/boards/nrf6310/include/periph_conf.h index 3d5cedfa1c..3e804fbd72 100644 --- a/boards/nrf6310/include/periph_conf.h +++ b/boards/nrf6310/include/periph_conf.h @@ -45,7 +45,7 @@ extern "C" { /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -69,7 +69,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ #define UART_NUMOF (1U) @@ -85,7 +85,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name Radio device configuration + * @name Radio device configuration * * The radio is not guarded by a NUMOF define, as the radio is selected by its * own module in the build system. @@ -95,7 +95,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * @{ */ static const spi_conf_t spi_config[] = { @@ -117,7 +117,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name ADC configuration + * @name ADC configuration * * The configuration consists simply of a list of channels that should be used * @{ diff --git a/boards/nucleo-f030/include/board.h b/boards/nucleo-f030/include/board.h index 0317fa4e54..19f4b47557 100644 --- a/boards/nucleo-f030/include/board.h +++ b/boards/nucleo-f030/include/board.h @@ -31,7 +31,7 @@ extern "C" { #endif /** - * @brief Xtimer configuration + * @name Xtimer configuration * @{ */ #define XTIMER_WIDTH (16) diff --git a/boards/nucleo-f070/include/board.h b/boards/nucleo-f070/include/board.h index 4f442f7e00..3da4a94058 100644 --- a/boards/nucleo-f070/include/board.h +++ b/boards/nucleo-f070/include/board.h @@ -32,7 +32,7 @@ extern "C" { #endif /** - * @brief Xtimer configuration + * @name Xtimer configuration * @{ */ #define XTIMER_WIDTH (16) diff --git a/boards/nucleo-f072/include/board.h b/boards/nucleo-f072/include/board.h index 4a45e5fd01..a69850e219 100644 --- a/boards/nucleo-f072/include/board.h +++ b/boards/nucleo-f072/include/board.h @@ -30,7 +30,7 @@ extern "C" { #endif /** - * @brief Xtimer configuration + * @name Xtimer configuration * @{ */ #define XTIMER_WIDTH (16) diff --git a/boards/nucleo-f091/include/board.h b/boards/nucleo-f091/include/board.h index 4001e1a506..54669ce699 100644 --- a/boards/nucleo-f091/include/board.h +++ b/boards/nucleo-f091/include/board.h @@ -29,7 +29,7 @@ extern "C" { #endif /** - * @brief Xtimer configuration + * @name Xtimer configuration * @{ */ #define XTIMER_WIDTH (16) diff --git a/boards/nucleo-f103/include/board.h b/boards/nucleo-f103/include/board.h index 753596069e..086bb2a9bc 100755 --- a/boards/nucleo-f103/include/board.h +++ b/boards/nucleo-f103/include/board.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @name xtimer configuration + * @name xtimer configuration */ #define XTIMER_WIDTH (16) #define XTIMER_BACKOFF 5 diff --git a/boards/nucleo-f411/include/board.h b/boards/nucleo-f411/include/board.h index bcb823cbeb..7c4f23a8cf 100644 --- a/boards/nucleo-f411/include/board.h +++ b/boards/nucleo-f411/include/board.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @name xtimer configuration + * @name xtimer configuration * @{ */ #define XTIMER_DEV TIMER_DEV(0) diff --git a/boards/nucleo-f411/include/periph_conf.h b/boards/nucleo-f411/include/periph_conf.h index 1061f9c10b..d46b05dc7b 100644 --- a/boards/nucleo-f411/include/periph_conf.h +++ b/boards/nucleo-f411/include/periph_conf.h @@ -26,7 +26,7 @@ extern "C" { #endif /** - * @name Clock system configuration + * @name Clock system configuration * @{ */ #define CLOCK_HSE (8000000U) /* external oscillator */ @@ -49,7 +49,7 @@ extern "C" { /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -69,7 +69,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @brief UART configuration + * @name UART configuration * @{ */ static const uart_conf_t uart_config[] = { @@ -129,7 +129,7 @@ static const uart_conf_t uart_config[] = { #define UART_NUMOF (sizeof(uart_config) / sizeof(uart_config[0])) /** @} */ -/** @brief PWM configuration +/** @name PWM configuration * @{ */ static const pwm_conf_t pwm_config[] = { @@ -159,7 +159,7 @@ static const pwm_conf_t pwm_config[] = { /** @} */ /** - * @brief SPI configuration + * @name SPI configuration * * @note The spi_divtable is auto-generated from * `cpu/stm32_common/dist/spi_divtable/spi_divtable.c` @@ -199,7 +199,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name I2C configuration + * @name I2C configuration * @{ */ #define I2C_NUMOF (1U) @@ -227,14 +227,14 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name ADC configuration + * @name ADC configuration * @{ */ #define ADC_NUMOF (0) /** @} */ /** - * @name DAC configuration + * @name DAC configuration * @{ */ #define DAC_NUMOF (0) diff --git a/boards/nucleo-l053/include/board.h b/boards/nucleo-l053/include/board.h index d29f4f1c12..a2840657b7 100644 --- a/boards/nucleo-l053/include/board.h +++ b/boards/nucleo-l053/include/board.h @@ -31,7 +31,7 @@ extern "C" { #endif /** - * @name xtimer configuration + * @name xtimer configuration * @{ */ #define XTIMER_DEV TIMER_DEV(0) diff --git a/boards/nucleo-l053/include/periph_conf.h b/boards/nucleo-l053/include/periph_conf.h index 0fc55f62ef..702e1916be 100644 --- a/boards/nucleo-l053/include/periph_conf.h +++ b/boards/nucleo-l053/include/periph_conf.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @name Clock system configuration + * @name Clock system configuration * @{ */ #define CLOCK_HSI (16000000U) /* internal oscillator */ @@ -52,7 +52,7 @@ extern "C" { /** @} */ /** - * @brief Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -71,7 +71,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @brief UART configuration + * @name UART configuration * @{ */ static const uart_conf_t uart_config[] = { @@ -104,7 +104,7 @@ static const uart_conf_t uart_config[] = { /** @} */ /** - * @brief PWM configuration + * @name PWM configuration * @{ */ static const pwm_conf_t pwm_config[] = { @@ -124,7 +124,7 @@ static const pwm_conf_t pwm_config[] = { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * * @note The spi_divtable is auto-generated from * `cpu/stm32_common/dist/spi_divtable/spi_divtable.c` @@ -164,7 +164,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name ADC configuration + * @name ADC configuration * @{ */ #define ADC_NUMOF (0) @@ -172,14 +172,14 @@ static const spi_conf_t spi_config[] = { /** - * @name DAC configuration + * @name DAC configuration * @{ */ #define DAC_NUMOF (0) /** @} */ /** - * @name RTC configuration + * @name RTC configuration * @{ */ #define RTC_NUMOF (0U) diff --git a/boards/nucleo-l073/include/board.h b/boards/nucleo-l073/include/board.h index 42acbcf535..803bc5cb7f 100644 --- a/boards/nucleo-l073/include/board.h +++ b/boards/nucleo-l073/include/board.h @@ -31,7 +31,7 @@ extern "C" { #endif /** - * @name xtimer configuration + * @name xtimer configuration * @{ */ #define XTIMER_DEV TIMER_DEV(0) diff --git a/boards/nucleo-l073/include/periph_conf.h b/boards/nucleo-l073/include/periph_conf.h index 2a7004e205..e14442e1d0 100644 --- a/boards/nucleo-l073/include/periph_conf.h +++ b/boards/nucleo-l073/include/periph_conf.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @name Clock system configuration + * @name Clock system configuration * @{ */ #define CLOCK_HSI (16000000U) /* internal oscillator */ @@ -52,7 +52,7 @@ extern "C" { /** @} */ /** - * @brief Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -71,7 +71,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @brief UART configuration + * @name UART configuration * @{ */ static const uart_conf_t uart_config[] = { @@ -104,7 +104,7 @@ static const uart_conf_t uart_config[] = { /** @} */ /** - * @brief PWM configuration + * @name PWM configuration * @{ */ static const pwm_conf_t pwm_config[] = { @@ -124,7 +124,7 @@ static const pwm_conf_t pwm_config[] = { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * * @note The spi_divtable is auto-generated from * `cpu/stm32_common/dist/spi_divtable/spi_divtable.c` @@ -164,7 +164,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name ADC configuration + * @name ADC configuration * @{ */ #define ADC_NUMOF (0) @@ -172,14 +172,14 @@ static const spi_conf_t spi_config[] = { /** - * @name DAC configuration + * @name DAC configuration * @{ */ #define DAC_NUMOF (0) /** @} */ /** - * @name RTC configuration + * @name RTC configuration * @{ */ #define RTC_NUMOF (0U) diff --git a/boards/nucleo-l476/include/periph_conf.h b/boards/nucleo-l476/include/periph_conf.h index 650d95097c..4962c50f22 100644 --- a/boards/nucleo-l476/include/periph_conf.h +++ b/boards/nucleo-l476/include/periph_conf.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @name Clock system configuration + * @name Clock system configuration * @{ */ /* 0: no external high speed crystal available @@ -66,7 +66,7 @@ extern "C" { /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -85,7 +85,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @brief UART configuration + * @name UART configuration * @{ */ static const uart_conf_t uart_config[] = { @@ -141,7 +141,7 @@ static const uart_conf_t uart_config[] = { /** @} */ /** - * @brief PWM configuration + * @name PWM configuration * @{ */ static const pwm_conf_t pwm_config[] = { @@ -181,7 +181,7 @@ static const pwm_conf_t pwm_config[] = { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * * @note The spi_divtable is auto-generated from * `cpu/stm32_common/dist/spi_divtable/spi_divtable.c` @@ -221,14 +221,14 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name ADC configuration + * @name ADC configuration * @{ */ #define ADC_NUMOF (0) /** @} */ /** - * @name DAC configuration + * @name DAC configuration * @{ */ #define DAC_NUMOF (0) diff --git a/boards/nucleo144-common/include/board_common.h b/boards/nucleo144-common/include/board_common.h index 42a76af692..0d02b61f27 100644 --- a/boards/nucleo144-common/include/board_common.h +++ b/boards/nucleo144-common/include/board_common.h @@ -32,7 +32,7 @@ extern "C" { #endif /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(PORT_B, 0) diff --git a/boards/nucleo144-f207/include/periph_conf.h b/boards/nucleo144-f207/include/periph_conf.h index f0c6c64b0c..0121e448af 100644 --- a/boards/nucleo144-f207/include/periph_conf.h +++ b/boards/nucleo144-f207/include/periph_conf.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @name Clock system configuration + * @name Clock system configuration * @{ */ #define CLOCK_HSE (8000000U) /* external oscillator */ @@ -71,7 +71,7 @@ static const pwm_conf_t pwm_config[] = { /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -105,8 +105,9 @@ static const timer_conf_t timer_config[] = { #define TIMER_NUMOF (sizeof(timer_config) / sizeof(timer_config[0])) /** @} */ + /** - * @name UART configuration + * @name UART configuration * @{ */ static const uart_conf_t uart_config[] = { @@ -167,7 +168,7 @@ static const uart_conf_t uart_config[] = { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * * @note The spi_divtable is auto-generated from * `cpu/stm32_common/dist/spi_divtable/spi_divtable.c` @@ -217,7 +218,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name I2C configuration + * @name I2C configuration * @{ */ #define I2C_NUMOF (1U) @@ -247,7 +248,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name ADC configuration + * @name ADC configuration * * We need to define the following fields: * PIN, device (ADCx), channel @@ -262,14 +263,14 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name DAC configuration + * @name DAC configuration * @{ */ #define DAC_NUMOF (0) /** @} */ /** - * @brief RTC configuration + * @name RTC configuration * @{ */ #define RTC_NUMOF (1) diff --git a/boards/nucleo144-f303/include/periph_conf.h b/boards/nucleo144-f303/include/periph_conf.h index 279662af9c..f0c85f379c 100644 --- a/boards/nucleo144-f303/include/periph_conf.h +++ b/boards/nucleo144-f303/include/periph_conf.h @@ -26,7 +26,7 @@ extern "C" { #endif /** - * @name Clock system configuration + * @name Clock system configuration * @{ */ #define CLOCK_HSE (8000000U) /* external oscillator */ @@ -46,7 +46,7 @@ extern "C" { /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -65,7 +65,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ static const uart_conf_t uart_config[] = { @@ -124,7 +124,7 @@ static const uart_conf_t uart_config[] = { /** @} */ /** - * @brief PWM configuration + * @name PWM configuration * @{ */ static const pwm_conf_t pwm_config[] = { @@ -144,7 +144,7 @@ static const pwm_conf_t pwm_config[] = { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * * @note The spi_divtable is auto-generated from * `cpu/stm32_common/dist/spi_divtable/spi_divtable.c` @@ -185,7 +185,7 @@ static const spi_conf_t spi_config[] = { /** - * @name I2C configuration + * @name I2C configuration * @{ */ #define I2C_NUMOF (0U) @@ -199,7 +199,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name DAC configuration + * @name DAC configuration * @{ */ #define DAC_NUMOF (0) diff --git a/boards/nucleo144-f413/include/board.h b/boards/nucleo144-f413/include/board.h index 8740c3e87b..6de395122b 100644 --- a/boards/nucleo144-f413/include/board.h +++ b/boards/nucleo144-f413/include/board.h @@ -30,7 +30,7 @@ extern "C" { #endif /** - * @name xtimer configuration + * @name xtimer configuration * @{ */ #define XTIMER_DEV TIMER_DEV(0) diff --git a/boards/nucleo144-f413/include/periph_conf.h b/boards/nucleo144-f413/include/periph_conf.h index a47fb1d92e..d7e0a82aa4 100644 --- a/boards/nucleo144-f413/include/periph_conf.h +++ b/boards/nucleo144-f413/include/periph_conf.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @name Clock system configuration + * @name Clock system configuration * @{ */ #define CLOCK_HSE (8000000U) /* external oscillator */ @@ -51,7 +51,7 @@ extern "C" { /** @} */ /** - * @brief Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -70,7 +70,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ static const uart_conf_t uart_config[] = { @@ -129,7 +129,7 @@ static const uart_conf_t uart_config[] = { /** @} */ /** - * @brief PWM configuration + * @name PWM configuration * @{ */ static const pwm_conf_t pwm_config[] = { @@ -169,7 +169,7 @@ static const pwm_conf_t pwm_config[] = { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * * @note The spi_divtable is auto-generated from * `cpu/stm32_common/dist/spi_divtable/spi_divtable.c` @@ -192,8 +192,6 @@ static const uint8_t spi_divtable[2][5] = { } }; - - static const spi_conf_t spi_config[] = { { .dev = SPI1, @@ -210,9 +208,8 @@ static const spi_conf_t spi_config[] = { #define SPI_NUMOF (sizeof(spi_config) / sizeof(spi_config[0])) /** @} */ - /** - * @name I2C configuration + * @name I2C configuration * @{ */ #define I2C_NUMOF (1U) @@ -240,21 +237,21 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name ADC configuration + * @name ADC configuration * @{ */ #define ADC_NUMOF (0) /** @} */ /** - * @name DAC configuration + * @name DAC configuration * @{ */ #define DAC_NUMOF (0) /** @} */ /** - * @name RTC configuration + * @name RTC configuration * @{ */ #define RTC_NUMOF (1) diff --git a/boards/nucleo144-f429/include/board.h b/boards/nucleo144-f429/include/board.h index 6dd94f7de0..27c88a1b4d 100644 --- a/boards/nucleo144-f429/include/board.h +++ b/boards/nucleo144-f429/include/board.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @name xtimer configuration + * @name xtimer configuration * @{ */ #define XTIMER_DEV TIMER_DEV(0) diff --git a/boards/nucleo144-f429/include/periph_conf.h b/boards/nucleo144-f429/include/periph_conf.h index 14144736a2..2cd6b1112f 100644 --- a/boards/nucleo144-f429/include/periph_conf.h +++ b/boards/nucleo144-f429/include/periph_conf.h @@ -26,7 +26,7 @@ extern "C" { #endif /** - * @name Clock system configuration + * @name Clock system configuration * @{ */ #define CLOCK_HSE (8000000U) /* external oscillator */ @@ -49,7 +49,7 @@ extern "C" { /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -68,7 +68,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ static const uart_conf_t uart_config[] = { @@ -127,7 +127,7 @@ static const uart_conf_t uart_config[] = { /** @} */ /** - * @brief PWM configuration + * @name PWM configuration * @{ */ static const pwm_conf_t pwm_config[] = { @@ -157,7 +157,7 @@ static const pwm_conf_t pwm_config[] = { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * * @note The spi_divtable is auto-generated from * `cpu/stm32_common/dist/spi_divtable/spi_divtable.c` @@ -196,9 +196,8 @@ static const spi_conf_t spi_config[] = { #define SPI_NUMOF (sizeof(spi_config) / sizeof(spi_config[0])) /** @} */ - /** - * @name I2C configuration + * @name I2C configuration * @{ */ #define I2C_NUMOF (1U) @@ -226,17 +225,17 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name ADC configuration + * @name ADC configuration * @{ */ #define ADC_NUMOF (0) /** @} */ /** - * @name DAC configuration + * @name DAC configuration * @{ */ -#define DAC_NUMOF (0) +#define DAC_NUMOF (0) /** @} */ #ifdef __cplusplus diff --git a/boards/nucleo144-f446/include/board.h b/boards/nucleo144-f446/include/board.h index cf7f93dc8f..94a322f80a 100644 --- a/boards/nucleo144-f446/include/board.h +++ b/boards/nucleo144-f446/include/board.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @name xtimer configuration + * @name xtimer configuration * @{ */ #define XTIMER_DEV TIMER_DEV(0) diff --git a/boards/nucleo144-f446/include/periph_conf.h b/boards/nucleo144-f446/include/periph_conf.h index 8c08db6783..fae5da3097 100644 --- a/boards/nucleo144-f446/include/periph_conf.h +++ b/boards/nucleo144-f446/include/periph_conf.h @@ -26,7 +26,7 @@ extern "C" { #endif /** - * @name Clock system configuration + * @name Clock system configuration * @{ */ #define CLOCK_HSE (8000000U) /* external oscillator */ @@ -49,7 +49,7 @@ extern "C" { /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -68,7 +68,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ static const uart_conf_t uart_config[] = { @@ -127,7 +127,7 @@ static const uart_conf_t uart_config[] = { /** @} */ /** - * @brief PWM configuration + * @name PWM configuration * @{ */ static const pwm_conf_t pwm_config[] = { @@ -167,7 +167,7 @@ static const pwm_conf_t pwm_config[] = { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * * @note The spi_divtable is auto-generated from * `cpu/stm32_common/dist/spi_divtable/spi_divtable.c` @@ -206,9 +206,8 @@ static const spi_conf_t spi_config[] = { #define SPI_NUMOF (sizeof(spi_config) / sizeof(spi_config[0])) /** @} */ - /** - * @name I2C configuration + * @name I2C configuration * @{ */ #define I2C_NUMOF (1U) @@ -236,17 +235,17 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name ADC configuration + * @name ADC configuration * @{ */ #define ADC_NUMOF (0) /** @} */ /** - * @name DAC configuration + * @name DAC configuration * @{ */ -#define DAC_NUMOF (0) +#define DAC_NUMOF (0) /** @} */ #ifdef __cplusplus diff --git a/boards/nucleo32-l031/include/periph_conf.h b/boards/nucleo32-l031/include/periph_conf.h index 5c66efa9c0..3559af3a52 100644 --- a/boards/nucleo32-l031/include/periph_conf.h +++ b/boards/nucleo32-l031/include/periph_conf.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @name Clock system configuration + * @name Clock system configuration * @{ */ #define CLOCK_HSI (16000000U) /* internal oscillator */ @@ -52,7 +52,7 @@ extern "C" { /** @} */ /** - * @brief Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -71,7 +71,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @brief UART configuration + * @name UART configuration * @{ */ static const uart_conf_t uart_config[] = { @@ -93,7 +93,7 @@ static const uart_conf_t uart_config[] = { /** @} */ /** - * @brief PWM configuration + * @name PWM configuration * @{ */ static const pwm_conf_t pwm_config[] = { @@ -113,7 +113,7 @@ static const pwm_conf_t pwm_config[] = { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * @{ */ static const uint8_t spi_divtable[2][5] = { @@ -150,22 +150,21 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name ADC configuration + * @name ADC configuration * @{ */ #define ADC_NUMOF (0) /** @} */ - /** - * @name DAC configuration + * @name DAC configuration * @{ */ #define DAC_NUMOF (0) /** @} */ /** - * @name RTC configuration + * @name RTC configuration * @{ */ #define RTC_NUMOF (0U) diff --git a/boards/opencm904/include/board.h b/boards/opencm904/include/board.h index 4fb218f24a..badeb5bfb7 100755 --- a/boards/opencm904/include/board.h +++ b/boards/opencm904/include/board.h @@ -67,7 +67,7 @@ extern "C" { #define UART_STDIO_DEV UART_DEV(0) /** - * @brief Override with ROBOTIS Bluetooth antenna baudrate for STDIO + * @name Override with ROBOTIS Bluetooth antenna baudrate for STDIO * @{ */ #ifndef UART_STDIO_BAUDRATE diff --git a/boards/openmote-cc2538/include/board.h b/boards/openmote-cc2538/include/board.h index a7d658b948..43e57e380c 100644 --- a/boards/openmote-cc2538/include/board.h +++ b/boards/openmote-cc2538/include/board.h @@ -29,7 +29,7 @@ #endif /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(2, 4) @@ -61,7 +61,7 @@ /** @} */ /** - * @name xtimer configuration + * @name xtimer configuration * @{ */ #define XTIMER_DEV (0) @@ -74,7 +74,7 @@ /** @} */ /** - * @name Flash Customer Configuration Area (CCA) parameters + * @name Flash Customer Configuration Area (CCA) parameters * @{ */ #ifndef UPDATE_CCA @@ -87,7 +87,7 @@ /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/openmote-cc2538/include/periph_conf.h b/boards/openmote-cc2538/include/periph_conf.h index 88b9fa8e3b..aadf637d9d 100644 --- a/boards/openmote-cc2538/include/periph_conf.h +++ b/boards/openmote-cc2538/include/periph_conf.h @@ -27,14 +27,14 @@ #endif /** - * @name Clock system configuration + * @name Clock system configuration * @{ */ #define CLOCK_CORECLOCK (32000000U) /* desired core clock frequency, 32MHz */ /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -65,7 +65,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ #define UART_NUMOF (1U) @@ -82,7 +82,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name I2C configuration + * @name I2C configuration * @{ */ #define I2C_NUMOF 1 @@ -120,7 +120,7 @@ static const spi_clk_conf_t spi_clk_config[] = { }; /** - * @name SPI configuration + * @name SPI configuration * @{ */ static const spi_conf_t spi_config[] = { @@ -137,7 +137,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name Radio peripheral configuration + * @name Radio peripheral configuration * @{ */ #define RADIO_IRQ_PRIO 1 diff --git a/boards/pca10000/include/board.h b/boards/pca10000/include/board.h index d2a6349f2d..d743a81fb6 100644 --- a/boards/pca10000/include/board.h +++ b/boards/pca10000/include/board.h @@ -29,7 +29,7 @@ extern "C" { #endif /** - * @brief Xtimer configuration + * @name Xtimer configuration * @{ */ #define XTIMER_DEV (0) @@ -39,7 +39,7 @@ extern "C" { /** @} */ /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(0, 21) diff --git a/boards/pca10000/include/periph_conf.h b/boards/pca10000/include/periph_conf.h index 606bf6fe85..d95e9a7930 100644 --- a/boards/pca10000/include/periph_conf.h +++ b/boards/pca10000/include/periph_conf.h @@ -44,7 +44,7 @@ extern "C" { /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -68,7 +68,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ #define UART_NUMOF (1U) @@ -81,7 +81,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name ADC configuration + * @name ADC configuration * * The configuration consists simply of a list of channels that should be used * @{ @@ -90,7 +90,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name Radio device configuration + * @name Radio device configuration * * The radio is not guarded by a NUMOF define, as the radio is selected by its * own module in the build system. diff --git a/boards/pca10005/include/board.h b/boards/pca10005/include/board.h index b65a0711bb..54e3dd4eec 100644 --- a/boards/pca10005/include/board.h +++ b/boards/pca10005/include/board.h @@ -29,7 +29,7 @@ extern "C" { #endif /** - * @brief Xtimer configuration + * @name Xtimer configuration * @{ */ #define XTIMER_DEV (0) @@ -39,7 +39,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/pca10005/include/periph_conf.h b/boards/pca10005/include/periph_conf.h index 77b68e6c77..26c290f075 100644 --- a/boards/pca10005/include/periph_conf.h +++ b/boards/pca10005/include/periph_conf.h @@ -44,7 +44,7 @@ extern "C" { /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -58,7 +58,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ #define UART_NUMOF (1U) @@ -78,7 +78,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * @{ */ static const spi_conf_t spi_config[] = { @@ -100,7 +100,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name ADC configuration + * @name ADC configuration * * The configuration consists simply of a list of channels that should be used * @{ @@ -110,7 +110,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name Radio device configuration + * @name Radio device configuration * * The radio is not guarded by a NUMOF define, as the radio is selected by its * own module in the build system. diff --git a/boards/pic32-clicker/include/board.h b/boards/pic32-clicker/include/board.h index eb1c1b5d40..ef31b06355 100644 --- a/boards/pic32-clicker/include/board.h +++ b/boards/pic32-clicker/include/board.h @@ -25,8 +25,8 @@ * @author Neil Jones <Neil.Jones@imgtec.com> */ -#ifndef _BOARD_H_ -#define _BOARD_H_ +#ifndef BOARD_H +#define BOARD_H #ifdef __cplusplus extern "C" { @@ -35,13 +35,13 @@ extern "C" { #include "vendor/p32mx470f512h.h" /** - * @brief Set how many increments of the count register per uS - * needed by the timer code. + * @brief Set how many increments of the count register per uS + * needed by the timer code. */ #define TICKS_PER_US (48) /** - * @brief We are using an External Interrupt Controller (all pic32 devices use this mode) + * @brief We are using an External Interrupt Controller (all pic32 devices use this mode) */ #define EIC_IRQ (1) @@ -55,5 +55,5 @@ void board_init(void); #endif -#endif /* _BOARD_H_ */ +#endif /* BOARD_H */ /** @} */ diff --git a/boards/pic32-clicker/include/periph_conf.h b/boards/pic32-clicker/include/periph_conf.h index 209f929619..66fa70bc0c 100644 --- a/boards/pic32-clicker/include/periph_conf.h +++ b/boards/pic32-clicker/include/periph_conf.h @@ -17,11 +17,11 @@ * @file * @brief peripheral configuration for the MikroE PIC32 Clicker * - * @author Neil Jones <Neil.Jones@imgtec.com> + * @author Neil Jones <Neil.Jones@imgtec.com> */ -#ifndef _PERIPH_CONF_H_ -#define _PERIPH_CONF_H_ +#ifndef PERIPH_CONF_H +#define PERIPH_CONF_H #ifdef __cplusplus extern "C" { @@ -29,14 +29,14 @@ extern "C" { /** - * @brief The peripheral clock is required for the UART Baud rate calculation - * It is configured by the 'config' registers (see pic32_config_settings.c) - * Note 120MHz is the max F for this device. + * @brief The peripheral clock is required for the UART Baud rate calculation + * It is configured by the 'config' registers (see pic32_config_settings.c) + * Note 120MHz is the max F for this device. */ #define PERIPHERAL_CLOCK (96000000) /* Hz */ /** - * @brief Timer definitions + * @name Timer definitions * @{ */ #define TIMER_NUMOF (1) @@ -44,7 +44,7 @@ extern "C" { /** @} */ /** - * @brief UART Definitions + * @name UART Definitions * There are 4 UARTS available on this CPU. * We route debug via UART3 on this board, * this is the UART connected to the MikroBUS @@ -61,5 +61,5 @@ extern "C" { } #endif -#endif +#endif /* PERIPH_CONF_H */ /** @} */ diff --git a/boards/pic32-wifire/include/board.h b/boards/pic32-wifire/include/board.h index 02c4db1dcd..de5b7cba80 100644 --- a/boards/pic32-wifire/include/board.h +++ b/boards/pic32-wifire/include/board.h @@ -35,18 +35,18 @@ extern "C" { #include "vendor/p32mz2048efg100.h" /** - * @brief Set how many increments of the count register per uS - * needed by the timer code. + * @brief Set how many increments of the count register per uS + * needed by the timer code. */ #define TICKS_PER_US (100) /** - * @brief We are using an External Interrupt Controller (all pic32 devices use this mode) + * @brief We are using an External Interrupt Controller (all pic32 devices use this mode) */ -#define EIC_IRQ (1) +#define EIC_IRQ (1) /** - * @brief Board level initialisation + * @brief Board level initialisation */ void board_init(void); diff --git a/boards/pic32-wifire/include/periph_conf.h b/boards/pic32-wifire/include/periph_conf.h index d53ea72b45..8a50a797e1 100644 --- a/boards/pic32-wifire/include/periph_conf.h +++ b/boards/pic32-wifire/include/periph_conf.h @@ -27,13 +27,13 @@ extern "C" { #endif /** - * @brief The peripheral clock is required for the UART Baud rate calculation - * It is configured by the 'config' registers (see pic32_config_settings.c) + * @brief The peripheral clock is required for the UART Baud rate calculation + * It is configured by the 'config' registers (see pic32_config_settings.c) */ #define PERIPHERAL_CLOCK (100000000) /* Hz */ /** - * @brief Timer definitions + * @name Timer definitions * @{ */ #define TIMER_NUMOF (1) @@ -41,7 +41,7 @@ extern "C" { /** @} */ /** - * @brief UART Definitions + * @name UART Definitions * There are 6 UARTS available on this CPU. * We route debug via UART4 on this board, * this is the UART connected to the FTDI USB <-> UART device. diff --git a/boards/qemu-i386/include/board.h b/boards/qemu-i386/include/board.h index bafb3d9549..c9d63b9e93 100644 --- a/boards/qemu-i386/include/board.h +++ b/boards/qemu-i386/include/board.h @@ -26,7 +26,7 @@ extern "C" { #endif /** - * @brief Serial port configuration + * @name Serial port configuration * @{ */ #define UART_PORT (COM1_PORT) /* IO port to use for UART */ diff --git a/boards/remote-pa/include/board.h b/boards/remote-pa/include/board.h index 50827805de..3a165453f9 100644 --- a/boards/remote-pa/include/board.h +++ b/boards/remote-pa/include/board.h @@ -31,7 +31,7 @@ #endif /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(3, 2) @@ -56,14 +56,16 @@ /** @} */ /** - * @name User button pin definition + * @name User button pin definition * @{ */ #define BTN0_PIN GPIO_PIN(0, 3) /** @} */ /** - * @name 2.4GHz RF switch controlled by SW + * @name Radio configuration + * + * 2.4GHz RF switch controlled by SW * @{ */ #define RF_SWITCH_PORT GPIO_D @@ -74,7 +76,7 @@ /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/remote-pa/include/periph_conf.h b/boards/remote-pa/include/periph_conf.h index d82249a62d..eeb5e1a149 100644 --- a/boards/remote-pa/include/periph_conf.h +++ b/boards/remote-pa/include/periph_conf.h @@ -28,7 +28,7 @@ #endif /** - * @name UART configuration + * @name UART configuration * @{ */ #define UART_NUMOF (1U) @@ -42,11 +42,10 @@ /* UART 0 pin configuration */ #define UART_0_TX_PIN GPIO_PA1 #define UART_0_RX_PIN GPIO_PA0 - /** @} */ /** - * @name I2C configuration + * @name I2C configuration * @{ */ #define I2C_NUMOF 1 @@ -84,7 +83,7 @@ static const spi_clk_conf_t spi_clk_config[] = { }; /** - * @name SPI configuration + * @name SPI configuration * @{ */ static const spi_conf_t spi_config[] = { diff --git a/boards/saml21-xpro/include/board.h b/boards/saml21-xpro/include/board.h index 739d40a98d..794a03e401 100644 --- a/boards/saml21-xpro/include/board.h +++ b/boards/saml21-xpro/include/board.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(1, 10) @@ -42,12 +42,12 @@ extern "C" { /** @} */ /** - * @brief User button pin + * @brief User button pin */ #define SW0_PIN GPIO_PIN(PA, 2) /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/saml21-xpro/include/periph_conf.h b/boards/saml21-xpro/include/periph_conf.h index b4d2d2d044..6f8c3cdb28 100644 --- a/boards/saml21-xpro/include/periph_conf.h +++ b/boards/saml21-xpro/include/periph_conf.h @@ -30,12 +30,12 @@ extern "C" { #endif /** - * @brief GCLK reference speed + * @brief GCLK reference speed */ #define CLOCK_CORECLOCK (16000000U) /** - * @name Timer peripheral configuration + * @name Timer peripheral configuration * @{ */ #define TIMER_NUMOF (1U) @@ -49,7 +49,7 @@ extern "C" { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ #define UART_NUMOF (1U) @@ -71,7 +71,7 @@ extern "C" { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * @{ */ static const spi_conf_t spi_config[] = { @@ -93,14 +93,14 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name I2C configuration + * @name I2C configuration * @{ */ #define I2C_NUMOF (0) /** @} */ /** - * @name RTC configuration + * @name RTC configuration * @{ */ #define RTC_NUMOF (1) @@ -110,7 +110,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name RTT configuration + * @name RTT configuration * @{ */ #define RTT_FREQUENCY (32768U) diff --git a/boards/samr21-xpro/include/board.h b/boards/samr21-xpro/include/board.h index 373cb35e34..fbb71133a9 100644 --- a/boards/samr21-xpro/include/board.h +++ b/boards/samr21-xpro/include/board.h @@ -31,7 +31,7 @@ extern "C" { #endif /** - * @brief xtimer configuration + * @name xtimer configuration * @{ */ #define XTIMER_DEV TIMER_1 @@ -39,7 +39,7 @@ extern "C" { /** @} */ /** - * @name AT86RF233 configuration + * @name AT86RF233 configuration * * {spi bus, spi speed, cs pin, int pin, reset pin, sleep pin} */ @@ -51,7 +51,7 @@ extern "C" { .reset_pin = GPIO_PIN(PB, 15)} /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(0, 19) @@ -65,7 +65,7 @@ extern "C" { /** @} */ /** - * @name SW0 (Button) pin definitions + * @name SW0 (Button) pin definitions * @{ */ #define BUTTON_PORT PORT->Group[0] @@ -74,7 +74,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/samr21-xpro/include/periph_conf.h b/boards/samr21-xpro/include/periph_conf.h index 29f47cd2cd..ffde899245 100644 --- a/boards/samr21-xpro/include/periph_conf.h +++ b/boards/samr21-xpro/include/periph_conf.h @@ -32,7 +32,7 @@ extern "C" { #endif /** - * @brief External oscillator and clock configuration + * @name External oscillator and clock configuration * * For selection of the used CORECLOCK, we have implemented two choices: * @@ -79,7 +79,7 @@ extern "C" { /** @} */ /** - * @name Timer peripheral configuration + * @name Timer peripheral configuration * @{ */ #define TIMER_NUMOF (2U) @@ -100,7 +100,7 @@ extern "C" { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ static const uart_conf_t uart_config[] = { @@ -130,7 +130,7 @@ static const uart_conf_t uart_config[] = { /** @} */ /** - * @name PWM configuration + * @name PWM configuration * @{ */ #define PWM_0_EN 1 @@ -165,7 +165,7 @@ static const pwm_conf_t pwm_config[] = { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * @{ */ static const spi_conf_t spi_config[] = { @@ -197,7 +197,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name I2C configuration + * @name I2C configuration * @{ */ #define I2C_NUMOF (1U) @@ -219,7 +219,7 @@ static const spi_conf_t spi_config[] = { #define I2C_0_MUX GPIO_MUX_D /** - * @name RTC configuration + * @name RTC configuration * @{ */ #define RTC_NUMOF (1U) @@ -227,7 +227,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name RTT configuration + * @name RTT configuration * @{ */ #define RTT_NUMOF (1U) diff --git a/boards/seeeduino_arch-pro/include/board.h b/boards/seeeduino_arch-pro/include/board.h index 95600fb5b8..8aa7d4bb1a 100644 --- a/boards/seeeduino_arch-pro/include/board.h +++ b/boards/seeeduino_arch-pro/include/board.h @@ -34,7 +34,7 @@ extern "C" { #endif /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(1, 18) @@ -63,7 +63,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, include clocks, LEDs and stdio + * @brief Initialize board specific hardware, include clocks, LEDs and stdio */ void board_init(void); diff --git a/boards/seeeduino_arch-pro/include/periph_conf.h b/boards/seeeduino_arch-pro/include/periph_conf.h index be960be8ab..3ef04c16f4 100644 --- a/boards/seeeduino_arch-pro/include/periph_conf.h +++ b/boards/seeeduino_arch-pro/include/periph_conf.h @@ -25,7 +25,7 @@ extern "C" { #endif /** - * @name Timer configuration + * @name Timer configuration * @{ */ #define TIMER_NUMOF (1U) @@ -45,7 +45,7 @@ extern "C" { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ #define UART_NUMOF (2U) diff --git a/boards/slwstk6220a/include/board.h b/boards/slwstk6220a/include/board.h index 33b2e7e937..fc5d9df891 100644 --- a/boards/slwstk6220a/include/board.h +++ b/boards/slwstk6220a/include/board.h @@ -36,7 +36,7 @@ extern "C" { #define HW_TIMER TIMER_DEV(0) /** - * @brief Connection to the on-board temperature/humidity sensor (Si7021) + * @name Connection to the on-board temperature/humidity sensor (Si7021) * @{ */ #define SI7021_I2C (I2C_0) @@ -50,7 +50,7 @@ extern "C" { #define BC_PIN GPIO_PIN(PA,12) /** - * @brief User button pin definitions + * @name User button pin definitions * @{ */ #define PB0_PIN GPIO_PIN(PE,3) @@ -58,7 +58,7 @@ extern "C" { /** @} */ /** - * @brief LED pin definitions + * @name LED pin definitions * @{ */ #define LED0_PIN GPIO_PIN(PF, 6) @@ -74,7 +74,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/slwstk6220a/include/periph_conf.h b/boards/slwstk6220a/include/periph_conf.h index 002e79de7c..f9f8396cd4 100644 --- a/boards/slwstk6220a/include/periph_conf.h +++ b/boards/slwstk6220a/include/periph_conf.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @brief Clock configuration + * @name Clock configuration * @{ */ #define CLOCK_RCOSC (14000000) /* internal RC oscillator speed */ @@ -49,7 +49,7 @@ extern "C" { /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -67,7 +67,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ static const uart_conf_t uart_config[] = { diff --git a/boards/sodaq-autonomo/include/board.h b/boards/sodaq-autonomo/include/board.h index eff9e336cf..74d5299d39 100644 --- a/boards/sodaq-autonomo/include/board.h +++ b/boards/sodaq-autonomo/include/board.h @@ -30,7 +30,7 @@ extern "C" { #endif /** - * @brief xtimer configuration + * @name xtimer configuration * @{ */ #define XTIMER TIMER_1 @@ -38,7 +38,7 @@ extern "C" { /** @} */ /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(PA, 18) @@ -52,7 +52,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/sodaq-autonomo/include/periph_conf.h b/boards/sodaq-autonomo/include/periph_conf.h index 456196ef0d..c4a272ef52 100644 --- a/boards/sodaq-autonomo/include/periph_conf.h +++ b/boards/sodaq-autonomo/include/periph_conf.h @@ -29,7 +29,7 @@ extern "C" { #endif /** - * @brief External oscillator and clock configuration + * @name External oscillator and clock configuration * * For selection of the used CORECLOCK, we have implemented two choices: * @@ -76,7 +76,7 @@ extern "C" { /** @} */ /** - * @name Timer peripheral configuration + * @name Timer peripheral configuration * @{ */ #define TIMER_NUMOF (2U) @@ -97,7 +97,7 @@ extern "C" { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ * See Table 6.1 of the SAM D21 Datasheet */ @@ -146,7 +146,7 @@ static const uart_conf_t uart_config[] = { /** @} */ /** - * @name PWM configuration + * @name PWM configuration * @{ */ #define PWM_0_EN 1 @@ -181,7 +181,7 @@ static const pwm_conf_t pwm_config[] = { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * @{ */ static const spi_conf_t spi_config[] = { @@ -202,7 +202,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name I2C configuration + * @name I2C configuration * @{ */ #define I2C_NUMOF (1U) @@ -224,7 +224,7 @@ static const spi_conf_t spi_config[] = { #define I2C_0_MUX GPIO_MUX_C /** - * @name RTC configuration + * @name RTC configuration * @{ */ #define RTC_NUMOF (1U) @@ -232,7 +232,7 @@ static const spi_conf_t spi_config[] = { /** @} */ /** - * @name RTT configuration + * @name RTT configuration * @{ */ #define RTT_NUMOF (1U) diff --git a/boards/telosb/include/board.h b/boards/telosb/include/board.h index 4e700d9779..f245040ce8 100644 --- a/boards/telosb/include/board.h +++ b/boards/telosb/include/board.h @@ -42,7 +42,7 @@ extern "C" { #endif /** - * @brief Override default baudrate for STDIO + * @name Override default baudrate for STDIO * @{ */ #ifndef UART_STDIO_BAUDRATE @@ -51,7 +51,7 @@ extern "C" { /** @} */ /** - * @brief Xtimer configuration + * @name Xtimer configuration * @{ */ #define XTIMER_DEV (0) @@ -61,11 +61,10 @@ extern "C" { /** @} */ /** - * @brief CPU core configuration - * - * @todo Move this to the periph_conf.h + * @name CPU core configuration * @{ */ +/** @todo Move this to the periph_conf.h */ #define MSP430_INITIAL_CPU_SPEED 2457600uL #define F_CPU MSP430_INITIAL_CPU_SPEED #define F_RC_OSCILLATOR 32768 @@ -74,7 +73,7 @@ extern "C" { /** @} */ /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(4, 0) diff --git a/boards/telosb/include/periph_conf.h b/boards/telosb/include/periph_conf.h index 39ecfcfe5f..55fbc0928e 100644 --- a/boards/telosb/include/periph_conf.h +++ b/boards/telosb/include/periph_conf.h @@ -26,17 +26,17 @@ extern "C" { #endif /** - * @brief Clock configuration - * - * @todo Move all clock configuration code here from the board.h + * @name Clock configuration + * @{ */ +/** @todo Move all clock configuration code here from the board.h */ #define CLOCK_CORECLOCK (2457600U) #define CLOCK_CMCLK CLOCK_CORECLOCK /* no divider programmed */ /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ #define TIMER_NUMOF (1U) @@ -47,7 +47,7 @@ extern "C" { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ #define UART_NUMOF (1U) @@ -68,7 +68,7 @@ extern "C" { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * @{ */ #define SPI_NUMOF (1U) diff --git a/boards/udoo/include/board.h b/boards/udoo/include/board.h index 26f247b9c9..958ec382f7 100644 --- a/boards/udoo/include/board.h +++ b/boards/udoo/include/board.h @@ -29,7 +29,7 @@ extern "C" { #endif /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(PB, 27) @@ -43,7 +43,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/udoo/include/periph_conf.h b/boards/udoo/include/periph_conf.h index d9a729ece4..c00e34921e 100644 --- a/boards/udoo/include/periph_conf.h +++ b/boards/udoo/include/periph_conf.h @@ -1,4 +1,4 @@ -/* + /* * Copyright (C) 2014-2015 Freie Universität Berlin * * This file is subject to the terms and conditions of the GNU Lesser @@ -26,7 +26,7 @@ extern "C" { #endif /** - * @name Clock configuration + * @name Clock configuration * @{ */ /* targeted system core clock */ @@ -46,7 +46,7 @@ extern "C" { /** @} */ /** - * @name Timer peripheral configuration + * @name Timer peripheral configuration * @{ */ static const timer_conf_t timer_config[] = { @@ -62,7 +62,7 @@ static const timer_conf_t timer_config[] = { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ static const uart_conf_t uart_config[] = { @@ -83,7 +83,7 @@ static const uart_conf_t uart_config[] = { /** @} */ /** -* @name SPI configuration +* @name SPI configuration * @{ */ static const spi_conf_t spi_config[] = { diff --git a/boards/waspmote-pro/include/board.h b/boards/waspmote-pro/include/board.h index 1243fb6b93..107728a67f 100644 --- a/boards/waspmote-pro/include/board.h +++ b/boards/waspmote-pro/include/board.h @@ -30,15 +30,14 @@ extern "C" { #endif /** -* @brief As the CPU is too slow to handle 115200 baud, we set the default -* baudrate to 9600 for this board +* @brief As the CPU is too slow to handle 115200 baud, we set the default +* baudrate to 9600 for this board */ #define UART_STDIO_BAUDRATE (9600U) -/** @} */ /** - * @brief Use the UART 0 for STDIO on this board, if the XBee socket is not - * being used + * @brief Use the UART 0 for STDIO on this board, if the XBee socket is not + * being used */ #ifdef XBEE_UART #if XBEE_UART == 0 @@ -48,10 +47,8 @@ extern "C" { #endif #endif -/** @} */ - /** - * @name LED pin definitions + * @name LED pin definitions * @{ */ #define LED0_PORT PORTD @@ -61,7 +58,7 @@ extern "C" { /** @} */ /** - * @name Macros for controlling the on-board LEDs. + * @name Macros for controlling the on-board LEDs. * @{ */ #define LED0_ENABLE_PORT DDRD |= (1 << DDD6) @@ -84,7 +81,7 @@ extern "C" { /** @} */ /** - * @name Macros for controlling the on-board MUXes. + * @name Macros for controlling the on-board MUXes. * @{ */ #define MUX_PW_PORT PORTD @@ -146,12 +143,10 @@ extern "C" { #define SET_MUX_SOCKET0 MUX_PW_ENABLE_PORT; MUX_PW_ON; \ MUX_USB_XBEE_ENABLE_PORT; \ MUX_USB_XBEE_ON - - /** @} */ /** - * Context swap defines + * @brief Context swap defines * Setup to use PB5 which is pin change interrupt 5 * This emulates a software triggered interrupt **/ @@ -166,7 +161,7 @@ extern "C" { /** @endcond */ /** - * @brief xtimer configuration values + * @name xtimer configuration values * @{ */ #define XTIMER_WIDTH (16) @@ -176,7 +171,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, including clock, LEDs and std-IO + * @brief Initialize board specific hardware, including clock, LEDs and std-IO */ void board_init(void); diff --git a/boards/waspmote-pro/include/periph_conf.h b/boards/waspmote-pro/include/periph_conf.h index b7171a474c..a6c46a9c7e 100644 --- a/boards/waspmote-pro/include/periph_conf.h +++ b/boards/waspmote-pro/include/periph_conf.h @@ -26,14 +26,14 @@ extern "C" { #endif /** - * @brief Clock configuration + * @name Clock configuration * @{ */ #define CLOCK_CORECLOCK (14745600L) /** @} */ /** - * @name Timer peripheral configuration + * @name Timer peripheral configuration * * The ATmega1281 has 6 timers. Timer0 and Timer2 are 8 Bit Timers, * Timer0 has special uses too and therefore we'll avoid using it. @@ -60,9 +60,8 @@ extern "C" { #define TIMER_1_ISRC TIMER4_COMPC_vect /** @} */ - /** - * @name UART configuration + * @name UART configuration * * The UART devices have fixed pin mappings, so all we need to do, is to specify * which devices we would like to use and their corresponding RX interrupts. See @@ -85,11 +84,10 @@ extern "C" { #define UART_4800 (191) #define UART_9600 (95) #define UART_115200 (7) - /** @} */ /** - * @name SPI configuration + * @name SPI configuration * * The atmega1281 has only one hardware SPI with fixed pin configuration, so all * we can do here, is to enable or disable it... diff --git a/boards/weio/include/board.h b/boards/weio/include/board.h index 59fd00116a..624256c6e3 100644 --- a/boards/weio/include/board.h +++ b/boards/weio/include/board.h @@ -31,7 +31,7 @@ extern "C" { #endif /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(1, 13) @@ -57,7 +57,7 @@ extern "C" { /** @} */ /** - * @brief Initialize board specific hardware, include clocks, LEDs and stdio + * @brief Initialize board specific hardware, include clocks, LEDs and stdio */ void board_init(void); diff --git a/boards/weio/include/periph_conf.h b/boards/weio/include/periph_conf.h index d971d18b61..2a69bd147a 100644 --- a/boards/weio/include/periph_conf.h +++ b/boards/weio/include/periph_conf.h @@ -27,14 +27,14 @@ extern "C" { #endif /** - * @brief Clock configuration + * @name Clock configuration * @{ */ #define CLOCK_CORECLOCK (48000000U) /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ #define TIMER_NUMOF (1U) @@ -53,7 +53,7 @@ extern "C" { /* @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ #define UART_NUMOF (1U) @@ -78,7 +78,7 @@ extern "C" { /* @} */ /** - * @name SPI configuration + * @name SPI configuration * @{ */ static const spi_conf_t spi_config[] = { @@ -98,7 +98,7 @@ static const spi_conf_t spi_config[] = { /* @} */ /** - * @brief PWM configuration + * @name PWM configuration * @{ */ static const pwm_conf_t pwm_config[] = { diff --git a/boards/wsn430-common/include/board_common.h b/boards/wsn430-common/include/board_common.h index ab800b49d5..fba4a06eba 100644 --- a/boards/wsn430-common/include/board_common.h +++ b/boards/wsn430-common/include/board_common.h @@ -29,12 +29,12 @@ extern "C" { #endif /** - * @brief Address of the info memory + * @brief Address of the info memory */ #define INFOMEM (0x1000) /** - * @brief Xtimer configuration + * @name Xtimer configuration * @{ */ #define XTIMER_DEV (0) @@ -44,7 +44,7 @@ extern "C" { /** @} */ /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(4, 4) diff --git a/boards/wsn430-common/include/periph_conf.h b/boards/wsn430-common/include/periph_conf.h index 2acd0553b7..21fbf7b3e1 100644 --- a/boards/wsn430-common/include/periph_conf.h +++ b/boards/wsn430-common/include/periph_conf.h @@ -26,17 +26,17 @@ extern "C" { #endif /** - * @brief Clock configuration - * - * @todo Move all clock configuration code here from the board.h + * @name Clock configuration + * @{ */ +/** @todo Move all clock configuration code here from the board.h */ #define CLOCK_CORECLOCK (8000000U) #define CLOCK_CMCLK CLOCK_CORECLOCK /* no divider programmed */ /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ #define TIMER_NUMOF (1U) @@ -47,7 +47,7 @@ extern "C" { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ #define UART_NUMOF (1U) @@ -68,7 +68,7 @@ extern "C" { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * @{ */ #define SPI_NUMOF (1U) diff --git a/boards/wsn430-v1_3b/include/board.h b/boards/wsn430-v1_3b/include/board.h index b779f45481..7256f2d83e 100644 --- a/boards/wsn430-v1_3b/include/board.h +++ b/boards/wsn430-v1_3b/include/board.h @@ -42,11 +42,10 @@ extern "C" { #endif /** - * @brief CPU core configuration - * - * @todo Move this to the periph_conf.h + * @name CPU core configuration * @{ */ +/** @todo Move this to the periph_conf.h */ #define MSP430_INITIAL_CPU_SPEED 800000uL #define F_CPU MSP430_INITIAL_CPU_SPEED #define F_RC_OSCILLATOR 32768 diff --git a/boards/wsn430-v1_4/include/board.h b/boards/wsn430-v1_4/include/board.h index c3df1c46ab..d205566670 100644 --- a/boards/wsn430-v1_4/include/board.h +++ b/boards/wsn430-v1_4/include/board.h @@ -42,11 +42,10 @@ extern "C" { #endif /** - * @brief CPU core configuration - * - * @todo Move this to the periph_conf.h + * @name CPU core configuration * @{ */ +/** @todo Move this to the periph_conf.h */ #define MSP430_INITIAL_CPU_SPEED 800000uL #define F_CPU MSP430_INITIAL_CPU_SPEED #define F_RC_OSCILLATOR 32768 diff --git a/boards/yunjia-nrf51822/include/board.h b/boards/yunjia-nrf51822/include/board.h index 42fad7f4fd..3075640bce 100644 --- a/boards/yunjia-nrf51822/include/board.h +++ b/boards/yunjia-nrf51822/include/board.h @@ -28,7 +28,7 @@ extern "C" { #endif /** - * @brief Xtimer configuration + * @name Xtimer configuration * @{ */ #define XTIMER_DEV (0) diff --git a/boards/z1/include/board.h b/boards/z1/include/board.h index 1646253bf3..0b40bcc64f 100644 --- a/boards/z1/include/board.h +++ b/boards/z1/include/board.h @@ -45,7 +45,7 @@ extern "C" { #endif /** - * @brief Xtimer configuration + * @name Xtimer configuration * @{ */ #define XTIMER_DEV (0) @@ -55,11 +55,10 @@ extern "C" { /** @} */ /** - * @brief CPU core configuration - * - * @todo Move this to the periph_conf.h + * @name CPU core configuration * @{ */ +/** @todo Move this to the periph_conf.h */ #define MSP430_INITIAL_CPU_SPEED 8000000uL #ifndef F_CPU #define F_CPU MSP430_INITIAL_CPU_SPEED @@ -70,7 +69,7 @@ extern "C" { /** @} */ /** - * @brief LED pin definitions and handlers + * @name LED pin definitions and handlers * @{ */ #define LED0_PIN GPIO_PIN(4, 0) @@ -95,9 +94,8 @@ extern "C" { #define LED2_TOGGLE (LED_OUT_REG ^= LED2_MASK) /** @} */ - /** - * @brief User button configuration + * @name User button configuration * @{ */ #define USER_BTN_PxIN P2IN diff --git a/boards/z1/include/periph_conf.h b/boards/z1/include/periph_conf.h index 02bc391e3a..ad0cb8f9fb 100644 --- a/boards/z1/include/periph_conf.h +++ b/boards/z1/include/periph_conf.h @@ -26,17 +26,17 @@ extern "C" { #endif /** - * @brief Clock configuration - * - * @todo Move all clock configuration code here from the board.h + * @name Clock configuration + * @{ */ +/** @todo Move all clock configuration code here from the board.h */ #define CLOCK_CORECLOCK (8000000U) #define CLOCK_CMCLK CLOCK_CORECLOCK /* no divider programmed */ /** @} */ /** - * @name Timer configuration + * @name Timer configuration * @{ */ #define TIMER_NUMOF (1U) @@ -47,7 +47,7 @@ extern "C" { /** @} */ /** - * @name UART configuration + * @name UART configuration * @{ */ #define UART_NUMOF (1U) @@ -68,7 +68,7 @@ extern "C" { /** @} */ /** - * @name SPI configuration + * @name SPI configuration * @{ */ #define SPI_NUMOF (1U) -- GitLab