RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

Merge pull request #18444 from kfessel/p-fix-doc-grp

Browse Source 
doc: fix unbalaced grouping
This commit is contained in:
benpicco 2022-09-14 22:19:28 +02:00 committed by GitHub
commit b5bf5da38d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
160 changed files with 435 additions and 354 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
boards/adafruit-clue/include/board.h
View File

@ -94,7 +94,7 @@ extern "C" {
#define BACKLIGHT_MASK (1 << 5) /**< Backlight pin mask */
#define BACKLIGHT_ON (NRF_P1->OUTSET = BACKLIGHT_MASK) /**< Turn backlight on */
#define BACKLIGHT_OFF (NRF_P1->OUTCLR = BACKLIGHT_MASK) /**< Turn backlight off */
/** @ */
/** @} */
/**
* @name Display configuration

1
boards/adafruit-itsybitsy-nrf52/include/periph_conf.h
View File

@ -91,3 +91,4 @@ static const i2c_conf_t i2c_config[] = {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

1
boards/airfy-beacon/include/periph_conf.h
View File

@ -96,3 +96,4 @@ static const adc_conf_t adc_config[] = {3, 4, 5, 6};
#endif
#endif /* PERIPH_CONF_H */
/** @} */

1
boards/arduino-nano-33-ble/include/periph_conf.h
View File

@ -88,3 +88,4 @@ static const spi_conf_t spi_config[] = {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

1
boards/atmega1284p/include/periph_conf.h
View File

@ -40,3 +40,4 @@ extern "C" {
#include "periph_conf_atmega_common.h"
#endif /* PERIPH_CONF_H */
/** @} */

1
boards/atmega256rfr2-xpro/include/periph_conf.h
View File

@ -30,3 +30,4 @@ extern "C" {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

1
boards/atmega328p-xplained-mini/include/periph_conf.h
View File

@ -42,3 +42,4 @@ extern "C" {
#include "periph_conf_atmega_common.h"
#endif /* PERIPH_CONF_H */
/** @} */

1
boards/atmega328p/include/periph_conf.h
View File

@ -40,3 +40,4 @@ extern "C" {
#include "periph_conf_atmega_common.h"
#endif /* PERIPH_CONF_H */
/** @} */

5
boards/avr-rss2/include/board.h
View File

@ -57,6 +57,7 @@ extern "C" {
#define LED1_OFF (LED_PORT |= LED1_MASK)
#define LED1_ON (LED_PORT &= ~LED1_MASK)
#define LED1_TOGGLE (LED_PORT ^= LED1_MASK)
/** @} */
/**
* @name Usage of LED to turn on when a kernel panic occurs.
@ -71,6 +72,7 @@ extern "C" {
*/
#define DS18_PARAM_PIN GPIO_PIN(PORT_D, 7)
#define DS18_PARAM_PULL (GPIO_IN_PU)
/** @} */
/**
* @name xtimer configuration values
@ -80,6 +82,7 @@ extern "C" {
#define XTIMER_CHAN (0)
#define XTIMER_WIDTH (16)
#define XTIMER_HZ (62500UL)
/** @} */
/**
* @name Indicate Watchdog cleared in bootloader an
@ -94,7 +97,7 @@ extern "C" {
/**
* @name CPU clock scale for avr-rss2
*
* @{
*/
#define CPU_ATMEGA_CLK_SCALE_INIT CPU_ATMEGA_CLK_SCALE_DIV1
/** @} */

8
boards/cc1352-launchpad/include/periph_conf.h
View File

@ -76,14 +76,6 @@ static const timer_conf_t timer_config[] = {
* rts_pin.
* @{
*/
/**
* @name UART configuration
*
*
* Add a second UART configuration if using external pins.
* @{
*/
static const uart_conf_t uart_config[] = {
{
.regs = UART0,

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

@ -8,7 +8,7 @@
* directory for more details.
*/
/*
/**
* @defgroup boards_common_arduino-atmega Arduino Atmega Common
* @ingroup boards_common
* @brief Shared files and configuration for Arduino Atmega boards.
@ -93,7 +93,7 @@ extern "C" {
/**
* @name CPU clock scale for arduino boards
*
* @{
*/
#define CPU_ATMEGA_CLK_SCALE_INIT CPU_ATMEGA_CLK_SCALE_DIV1
/** @} */

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

@ -55,7 +55,7 @@ extern "C" {
#define ARDUINO_PIN_A3 GPIO_PIN(PA, 4)
#define ARDUINO_PIN_A4 GPIO_PIN(PA, 5)
#define ARDUINO_PIN_A5 GPIO_PIN(PB, 2)
/** @ */
/** @} */
/**
* @name Mapping of Arduino analog pins to RIOT ADC lines

1
boards/common/atmega/include/periph_conf_atmega_common.h
View File

@ -226,3 +226,4 @@ extern "C" {
#endif
#endif /* PERIPH_CONF_ATMEGA_COMMON_H */
/** @} */

4
boards/common/e104-bt50xxa-tb/include/periph_conf.h
View File

@ -74,8 +74,8 @@ static const i2c_conf_t i2c_config[] = {
static const uart_conf_t uart_config[] = {
{ /* Mapped to USB virtual COM port */
.dev = NRF_UARTE0,
.rx_pin = GPIO_PIN(0,14),
.tx_pin = GPIO_PIN(0,18),
.rx_pin = GPIO_PIN(0, 14),
.tx_pin = GPIO_PIN(0, 18),
#ifdef MODULE_PERIPH_UART_HW_FC
.rts_pin = GPIO_UNDEF,
.cts_pin = GPIO_UNDEF,

1
boards/common/nrf51/include/cfg_clock_16_0.h
View File

@ -45,3 +45,4 @@
#endif
#endif /* CFG_CLOCK_16_0_H */
/** @} */

1
boards/common/nrf51/include/cfg_clock_16_1.h
View File

@ -45,3 +45,4 @@
#endif
#endif /* CFG_CLOCK_16_1_H */
/** @} */

1
boards/common/nrf51/include/cfg_rtt_default.h
View File

@ -48,3 +48,4 @@ extern "C" {
#endif
#endif /* CFG_RTT_DEFAULT_H */
/** @} */

1
boards/common/nrf51/include/cfg_timer_01.h
View File

@ -57,3 +57,4 @@ static const timer_conf_t timer_config[] = {
#endif
#endif /* CFG_TIMER_01_H */
/** @} */

1
boards/common/nrf51/include/cfg_timer_012.h
View File

@ -64,3 +64,4 @@ static const timer_conf_t timer_config[] = {
#endif
#endif /* CFG_TIMER_012_H */
/** @} */

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

@ -74,7 +74,7 @@ extern "C" {
#define ARDUINO_PIN_A4 GPIO_PIN(PORT_F, 5)
#define ARDUINO_PIN_A5 GPIO_PIN(PORT_F, 10)
#endif
/** @ */
/** @} */
/**
* @name Mapping of Arduino analog pins to RIOT ADC lines

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

@ -63,7 +63,7 @@ extern "C" {
#define ARDUINO_PIN_A3 GPIO_PIN(PORT_B, 0)
#define ARDUINO_PIN_A4 GPIO_PIN(PORT_C, 1)
#define ARDUINO_PIN_A5 GPIO_PIN(PORT_C, 0)
/** @ */
/** @} */
/**
* @name Mapping of Arduino analog pins to RIOT ADC lines

7
boards/common/particle-mesh/include/periph_conf_common.h
View File

@ -39,9 +39,9 @@ extern "C" {
static const spi_conf_t spi_config[] = {
{
.dev = NRF_SPIM0,
.sclk = GPIO_PIN(1,15),
.mosi = GPIO_PIN(1,13),
.miso = GPIO_PIN(1,14),
.sclk = GPIO_PIN(1, 15),
.mosi = GPIO_PIN(1, 13),
.miso = GPIO_PIN(1, 14),
}
};
@ -69,3 +69,4 @@ static const pwm_conf_t pwm_config[] = {
#endif
#endif /* PERIPH_CONF_COMMON_H */
/** @} */

1
boards/derfmega128/include/periph_conf.h
View File

@ -30,3 +30,4 @@ extern "C" {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

1
boards/derfmega256/include/periph_conf.h
View File

@ -30,3 +30,4 @@ extern "C" {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

2
boards/ek-lm4f120xl/include/board.h
View File

@ -62,7 +62,7 @@ extern "C" {
#define LED2_ON (LED_PORT |= LED2_MASK)
#define LED2_OFF (LED_PORT &= ~LED2_MASK)
#define LED2_TOGGLE (LED_PORT ^= LED2_MASK)
/* @} */
/** @} */
/**
* @name ztimer configuration

1
boards/ek-lm4f120xl/include/periph_conf.h
View File

@ -66,6 +66,7 @@ static const timer_conf_t timer_config[] = {
#define TIMER_0_ISR isr_wtimer0a
#define TIMER_1_ISR isr_wtimer1a
/** @} */
/**
* @name UART configuration

2
boards/esp32-ethernet-kit-v1_0/include/periph_conf.h
View File

@ -13,6 +13,7 @@
* @file
* @author Gunar Schorcht <gunar@schorcht.net>
* @author Erik Ekman <eekman@google.com>
* @{
*/
#ifndef PERIPH_CONF_H
@ -39,6 +40,7 @@
#ifndef ADC_GPIOS
#define ADC_GPIOS { GPIO34, GPIO35, GPIO36, GPIO39 }
#endif
/** @} */
/**
* @name Declaration of GPIOs that can be used as DAC channels

5
boards/feather-nrf52840/include/periph_conf.h
View File

@ -37,8 +37,8 @@ extern "C" {
static const uart_conf_t uart_config[] = {
{
.dev = NRF_UARTE0,
.rx_pin = GPIO_PIN(0,24),
.tx_pin = GPIO_PIN(0,25),
.rx_pin = GPIO_PIN(0, 24),
.tx_pin = GPIO_PIN(0, 25),
#ifdef MODULE_PERIPH_UART_HW_FC
.rts_pin = GPIO_UNDEF,
.cts_pin = GPIO_UNDEF,
@ -88,3 +88,4 @@ static const i2c_conf_t i2c_config[] = {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

1
boards/hamilton/include/periph_conf.h
View File

@ -238,6 +238,7 @@ static const i2c_conf_t i2c_config[] = {
}
};
#define I2C_NUMOF ARRAY_SIZE(i2c_config)
/** @} */
/**
* @name Random Number Generator configuration

1
boards/maple-mini/include/periph_conf.h
View File

@ -157,3 +157,4 @@ static const spi_conf_t spi_config[] = {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

4
boards/mcb2388/include/board.h
View File

@ -99,8 +99,8 @@ extern "C" {
#define HD44780_PARAM_PIN_RS GPIO_PIN(1, 28)
#define HD44780_PARAM_PIN_RW GPIO_PIN(1, 29)
#define HD44780_PARAM_PIN_ENABLE GPIO_PIN(1, 31)
#define HD44780_PARAM_PINS_DATA { GPIO_PIN(1,24), GPIO_PIN(1,25), \
GPIO_PIN(1,26), GPIO_PIN(1,27), \
#define HD44780_PARAM_PINS_DATA { GPIO_PIN(1, 24), GPIO_PIN(1, 25), \
GPIO_PIN(1, 26), GPIO_PIN(1, 27), \
GPIO_UNDEF, GPIO_UNDEF, \
GPIO_UNDEF, GPIO_UNDEF }
/** @} */

1
boards/mcb2388/include/periph_conf.h
View File

@ -111,6 +111,7 @@ static const adc_conf_t adc_config[] = {
};
#define ADC_NUMOF (1)
/** @} */
/**
* @name I2C configuration

2
boards/mega-xplained/include/board.h
View File

@ -120,7 +120,7 @@ extern "C" {
/**
* @name CPU clock scale for mega-xplained
*
* @{
*/
#define CPU_ATMEGA_CLK_SCALE_INIT CPU_ATMEGA_CLK_SCALE_DIV1
/** @} */

1
boards/mega-xplained/include/periph_conf.h
View File

@ -49,3 +49,4 @@ extern "C" {
#include "periph_conf_atmega_common.h"
#endif /* PERIPH_CONF_H */
/** @} */

1
boards/msb-430/include/periph_conf.h
View File

@ -90,3 +90,4 @@ extern "C" {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

1
boards/msb-430h/include/periph_conf.h
View File

@ -92,3 +92,4 @@ extern "C" {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

1
boards/mulle/include/board.h
View File

@ -101,7 +101,6 @@ extern "C" {
/** @todo Work around missing RESET pin on Mulle v0.6x
*
* {spi bus, spi speed, cs pin, int pin, reset pin, sleep pin}
* @{
*/
#define AT86RF2XX_PARAM_CS SPI_HWCS(1)
#define AT86RF2XX_PARAM_INT GPIO_PIN(PORT_B, 9)

5
boards/nrf52832-mdk/include/periph_conf.h
View File

@ -36,8 +36,8 @@ extern "C" {
* @{
*/
#define UART_NUMOF (1U)
#define UART_PIN_RX GPIO_PIN(0,19)
#define UART_PIN_TX GPIO_PIN(0,20)
#define UART_PIN_RX GPIO_PIN(0, 19)
#define UART_PIN_TX GPIO_PIN(0, 20)
/** @} */
#ifdef __cplusplus
@ -45,3 +45,4 @@ extern "C" {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

1
boards/nrf52840-mdk-dongle/include/periph_conf.h
View File

@ -74,3 +74,4 @@ static const pwm_conf_t pwm_config[] = {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

5
boards/nrf52840-mdk/include/periph_conf.h
View File

@ -38,8 +38,8 @@ extern "C" {
static const uart_conf_t uart_config[] = {
{
.dev = NRF_UARTE0,
.rx_pin = GPIO_PIN(0,19),
.tx_pin = GPIO_PIN(0,20),
.rx_pin = GPIO_PIN(0, 19),
.tx_pin = GPIO_PIN(0, 20),
#ifdef MODULE_PERIPH_UART_HW_FC
.rts_pin = GPIO_UNDEF,
.cts_pin = GPIO_UNDEF,
@ -58,3 +58,4 @@ static const uart_conf_t uart_config[] = {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

8
boards/nrf52840dk/include/periph_conf.h
View File

@ -55,8 +55,8 @@ static const spi_conf_t spi_config[] = {
static const uart_conf_t uart_config[] = {
{ /* Mapped to USB virtual COM port */
.dev = NRF_UARTE0,
.rx_pin = GPIO_PIN(0,8),
.tx_pin = GPIO_PIN(0,6),
.rx_pin = GPIO_PIN(0, 8),
.tx_pin = GPIO_PIN(0, 6),
#ifdef MODULE_PERIPH_UART_HW_FC
.rts_pin = GPIO_UNDEF,
.cts_pin = GPIO_UNDEF,
@ -65,8 +65,8 @@ static const uart_conf_t uart_config[] = {
},
{ /* Mapped to Arduino D0/D1 pins */
.dev = NRF_UARTE1,
.rx_pin = GPIO_PIN(1,1),
.tx_pin = GPIO_PIN(1,2),
.rx_pin = GPIO_PIN(1, 1),
.tx_pin = GPIO_PIN(1, 2),
#ifdef MODULE_PERIPH_UART_HW_FC
.rts_pin = GPIO_UNDEF,
.cts_pin = GPIO_UNDEF,

1
boards/nrf52840dongle/include/periph_conf.h
View File

@ -117,3 +117,4 @@ static const i2c_conf_t i2c_config[] = {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

4
boards/nrf52dk/include/periph_conf.h
View File

@ -49,8 +49,8 @@ static const spi_conf_t spi_config[] = {
* @{
*/
#define UART_NUMOF (1U)
#define UART_PIN_RX GPIO_PIN(0,8)
#define UART_PIN_TX GPIO_PIN(0,6)
#define UART_PIN_RX GPIO_PIN(0, 8)
#define UART_PIN_TX GPIO_PIN(0, 6)
/** @} */
#ifdef __cplusplus

2
boards/nucleo-wl55jc/include/arduino_pinmap.h
View File

@ -57,7 +57,7 @@ extern "C" {
#define ARDUINO_PIN_A3 GPIO_PIN(PORT_B, 4)
#define ARDUINO_PIN_A4 GPIO_PIN(PORT_B, 14)
#define ARDUINO_PIN_A5 GPIO_PIN(PORT_B, 13)
/** @ */
/** @} */
/**
* @name Mapping of Arduino analog pins to RIOT ADC lines

1
boards/opencm904/include/periph_conf.h
View File

@ -101,3 +101,4 @@ static const uart_conf_t uart_config[] = {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

1
boards/openlabs-kw41z-mini/include/periph_conf.h
View File

@ -237,6 +237,7 @@ typedef struct {
uint8_t chan_numof; /**< number of actually configured channels */
uint8_t tpm_num; /**< FTM number used */
} pwm_conf_t;
/** @} */
/**
* @name PWM configuration

1
boards/openmote-b/include/board.h
View File

@ -112,6 +112,7 @@
#define OPENWSN_DEBUGPIN_FSM GPIO_PIN(1, 2) /* B2 */
#define OPENWSN_DEBUGPIN_TASK GPIO_PIN(1, 1) /* B1 */
#define OPENWSN_DEBUGPIN_RADIO GPIO_PIN(1, 0) /* B0 */
/** @} */
/**
* @name AT86RF215 configuration

2
boards/p-nucleo-wb55/include/arduino_pinmap.h
View File

@ -58,7 +58,7 @@ extern "C" {
#define ARDUINO_PIN_A3 GPIO_PIN(PORT_A, 0)
#define ARDUINO_PIN_A4 GPIO_PIN(PORT_C, 3)
#define ARDUINO_PIN_A5 GPIO_PIN(PORT_C, 2)
/** @ */
/** @} */
/**
* @name Mapping of Arduino analog pins to RIOT ADC lines

13
boards/particle-argon/include/periph_conf.h
View File

@ -34,8 +34,8 @@ extern "C" {
static const uart_conf_t uart_config[] = {
{
.dev = NRF_UARTE0,
.rx_pin = GPIO_PIN(0,8),
.tx_pin = GPIO_PIN(0,6),
.rx_pin = GPIO_PIN(0, 8),
.tx_pin = GPIO_PIN(0, 6),
#ifdef MODULE_PERIPH_UART_HW_FC
.rts_pin = GPIO_UNDEF,
.cts_pin = GPIO_UNDEF,
@ -44,11 +44,11 @@ static const uart_conf_t uart_config[] = {
},
{
.dev = NRF_UARTE1,
.rx_pin = GPIO_PIN(1,5),
.tx_pin = GPIO_PIN(1,4),
.rx_pin = GPIO_PIN(1, 5),
.tx_pin = GPIO_PIN(1, 4),
#ifdef MODULE_PERIPH_UART_HW_FC
.rts_pin = GPIO_PIN(1,6),
.cts_pin = GPIO_PIN(1,7),
.rts_pin = GPIO_PIN(1, 6),
.cts_pin = GPIO_PIN(1, 7),
#endif
.irqn = UARTE1_IRQn,
},
@ -65,3 +65,4 @@ static const uart_conf_t uart_config[] = {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

13
boards/particle-boron/include/periph_conf.h
View File

@ -34,8 +34,8 @@ extern "C" {
static const uart_conf_t uart_config[] = {
{
.dev = NRF_UARTE0,
.rx_pin = GPIO_PIN(0,8),
.tx_pin = GPIO_PIN(0,6),
.rx_pin = GPIO_PIN(0, 8),
.tx_pin = GPIO_PIN(0, 6),
#ifdef MODULE_PERIPH_UART_HW_FC
.rts_pin = GPIO_UNDEF,
.cts_pin = GPIO_UNDEF,
@ -44,11 +44,11 @@ static const uart_conf_t uart_config[] = {
},
{
.dev = NRF_UARTE1,
.rx_pin = GPIO_PIN(1,4),
.tx_pin = GPIO_PIN(1,5),
.rx_pin = GPIO_PIN(1, 4),
.tx_pin = GPIO_PIN(1, 5),
#ifdef MODULE_PERIPH_UART_HW_FC
.rts_pin = GPIO_PIN(1,7),
.cts_pin = GPIO_PIN(1,6),
.rts_pin = GPIO_PIN(1, 7),
.cts_pin = GPIO_PIN(1, 6),
#endif
.irqn = UARTE1_IRQn,
},
@ -65,3 +65,4 @@ static const uart_conf_t uart_config[] = {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

13
boards/particle-xenon/include/periph_conf.h
View File

@ -34,8 +34,8 @@ extern "C" {
static const uart_conf_t uart_config[] = {
{
.dev = NRF_UARTE0,
.rx_pin = GPIO_PIN(0,8),
.tx_pin = GPIO_PIN(0,6),
.rx_pin = GPIO_PIN(0, 8),
.tx_pin = GPIO_PIN(0, 6),
#ifdef MODULE_PERIPH_UART_HW_FC
.rts_pin = GPIO_UNDEF,
.cts_pin = GPIO_UNDEF,
@ -44,11 +44,11 @@ static const uart_conf_t uart_config[] = {
},
{
.dev = NRF_UARTE1,
.rx_pin = GPIO_PIN(1,10),
.tx_pin = GPIO_PIN(1,8),
.rx_pin = GPIO_PIN(1, 10),
.tx_pin = GPIO_PIN(1, 8),
#ifdef MODULE_PERIPH_UART_HW_FC
.rts_pin = GPIO_PIN(1,3),
.cts_pin = GPIO_PIN(1,11),
.rts_pin = GPIO_PIN(1, 3),
.cts_pin = GPIO_PIN(1, 11),
#endif
.irqn = UARTE1_IRQn,
},
@ -65,3 +65,4 @@ static const uart_conf_t uart_config[] = {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

1
boards/phynode-kw41z/include/board.h
View File

@ -60,6 +60,7 @@ extern "C"
#define LED3_ON (GPIOB->PCOR = LED3_MASK)
#define LED3_OFF (GPIOB->PSOR = LED3_MASK)
#define LED3_TOGGLE (GPIOB->PTOR = LED3_MASK)
/** @} */
/**
* @name Button pin definitions

1
boards/pic32-wifire/include/gpio_params.h
View File

@ -68,3 +68,4 @@ static const saul_gpio_params_t saul_gpio_params[] =
#endif
#endif /* GPIO_PARAMS_H */
/** @} */

2
boards/pinetime/include/board.h
View File

@ -61,7 +61,7 @@ extern "C" {
#endif
#define BACKLIGHT_ON (NRF_P0->OUTCLR = BACKLIGHT_MASK)
#define BACKLIGHT_OFF (NRF_P0->OUTSET = BACKLIGHT_MASK)
/** @ */
/** @} */
/**
* @name LCD configuration

1
boards/reel/include/board.h
View File

@ -98,6 +98,7 @@ extern "C" {
/**
* @name Digital proximity and ambient light sensor configuration (ADPS9960)
* @{
*/
#define ADPS9960_PARAM_I2C I2C_DEV(0)
#define ADPS9960_PARAM_ADDR (0x29)

5
boards/reel/include/periph_conf.h
View File

@ -37,8 +37,8 @@ extern "C" {
static const uart_conf_t uart_config[] = {
{
.dev = NRF_UARTE0,
.rx_pin = GPIO_PIN(0,8),
.tx_pin = GPIO_PIN(0,6),
.rx_pin = GPIO_PIN(0, 8),
.tx_pin = GPIO_PIN(0, 6),
#ifdef MODULE_PERIPH_UART_HW_FC
.rts_pin = GPIO_UNDEF,
.cts_pin = GPIO_UNDEF,
@ -73,3 +73,4 @@ static const spi_conf_t spi_config[] = {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

10
boards/remote-revb/include/board.h
View File

@ -114,11 +114,11 @@
* @{
*/
#define SDCARD_SPI_PARAM_SPI SPI_DEV(1)
#define SDCARD_SPI_PARAM_CS GPIO_PIN(0,7)
#define SDCARD_SPI_PARAM_CLK GPIO_PIN(2,4)
#define SDCARD_SPI_PARAM_MOSI GPIO_PIN(2,5)
#define SDCARD_SPI_PARAM_MISO GPIO_PIN(2,6)
#define SDCARD_SPI_PARAM_POWER GPIO_PIN(0,6)
#define SDCARD_SPI_PARAM_CS GPIO_PIN(0, 7)
#define SDCARD_SPI_PARAM_CLK GPIO_PIN(2, 4)
#define SDCARD_SPI_PARAM_MOSI GPIO_PIN(2, 5)
#define SDCARD_SPI_PARAM_MISO GPIO_PIN(2, 6)
#define SDCARD_SPI_PARAM_POWER GPIO_PIN(0, 6)
#define SDCARD_SPI_PARAM_POWER_AH false
/** @} */

1
boards/same54-xpro/include/periph_conf.h
View File

@ -392,6 +392,7 @@ static const sam0_common_gmac_config_t sam_gmac_config[] = {
.int_pin = GPIO_PIN(PD, 12),
}
};
/** @} */
#ifdef __cplusplus
}

1
boards/samr30-xpro/include/periph_conf.h
View File

@ -194,6 +194,7 @@ static const sam0_common_usb_config_t sam_usbdev_config[] = {
.gclk_src = SAM0_GCLK_48MHZ,
}
};
/** @} */
#ifdef __cplusplus
}

2
boards/sensebox_samd21/include/periph_conf.h
View File

@ -181,6 +181,7 @@ static const spi_conf_t spi_config[] = {
};
#define SPI_NUMOF ARRAY_SIZE(spi_config)
/** @} */
/**
* @name I2C configuration
@ -208,6 +209,7 @@ static const i2c_conf_t i2c_config[] = {
};
#define I2C_NUMOF ARRAY_SIZE(i2c_config)
/** @} */
/**
* @name RTT configuration

1
boards/sodaq-explorer/include/board.h
View File

@ -42,6 +42,7 @@ extern "C" {
/**
* @name User button
* @{
*/
#define BTN0_PIN GPIO_PIN(PA, 14)
#define BTN0_MODE GPIO_IN_PU

2
boards/sodaq-one/include/board.h
View File

@ -60,6 +60,7 @@ extern "C" {
/**
* @name User button
* @{
*/
#define BTN0_PIN GPIO_PIN(PA, 16)
#define BTN0_MODE GPIO_IN
@ -67,6 +68,7 @@ extern "C" {
/**
* @name GPS Time Pulse
* @{
*/
#define GPS_TIMEPULSE_PIN GPIO_PIN(PA, 14)
#define GPS_TIMEPULSE_MODE GPIO_IN

1
boards/sodaq-sara-sff/include/board.h
View File

@ -72,6 +72,7 @@ extern "C" {
/**
* @name User button
* @{
*/
#define BTN0_PIN GPIO_PIN(PB, 8)
#define BTN0_MODE GPIO_IN

1
boards/stm32f0discovery/include/periph_conf.h
View File

@ -145,3 +145,4 @@ static const spi_conf_t spi_config[] = {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

1
boards/stm32f3discovery/include/periph_conf.h
View File

@ -213,3 +213,4 @@ static const i2c_conf_t i2c_config[] = {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

2
boards/stm32f4discovery/include/arduino_pinmap.h
View File

@ -41,7 +41,7 @@ extern "C" {
#define ARDUINO_PIN_5 GPIO_PIN(PORT_A, 15)
#define ARDUINO_PIN_6 GPIO_PIN(PORT_B, 1)
#define ARDUINO_PIN_7 GPIO_PIN(PORT_B, 2)
/** @ */
/** @} */
/**
* @name Mapping of Arduino analog pins to RIOT ADC lines

1
boards/stm32l0538-disco/include/periph_conf.h
View File

@ -110,3 +110,4 @@ static const spi_conf_t spi_config[] = {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

2
boards/stm32mp157c-dk2/include/board.h
View File

@ -14,8 +14,6 @@
* @brief Board specific definitions for the STM32MP157C-DK2 board
*
* @author Gilles DOFFE <gilles.doffe@savoirfairelinux.com>
*
* @}
*/
#ifndef BOARD_H

1
boards/telosb/include/periph_conf.h
View File

@ -90,3 +90,4 @@ extern "C" {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

2
boards/ublox-c030-u201/include/arduino_pinmap.h
View File

@ -58,7 +58,7 @@ extern "C" {
#define ARDUINO_PIN_A3 GPIO_PIN(PORT_A, 4)
#define ARDUINO_PIN_A4 GPIO_PIN(PORT_B, 7)
#define ARDUINO_PIN_A5 GPIO_PIN(PORT_B, 6)
/** @ */
/** @} */
/**
* @name Mapping of Arduino analog pins to RIOT ADC lines

2
boards/waspmote-pro/include/board.h
View File

@ -152,7 +152,7 @@ extern "C" {
/**
* @name CPU clock scale for waspmote-pro
*
* @{
*/
#define CPU_ATMEGA_CLK_SCALE_INIT CPU_ATMEGA_CLK_SCALE_DIV1
/** @} */

1
boards/waspmote-pro/include/periph_conf.h
View File

@ -41,3 +41,4 @@ extern "C" {
#include "periph_conf_atmega_common.h"
#endif /* PERIPH_CONF_H */
/** @} */

1
boards/yunjia-nrf51822/include/periph_conf.h
View File

@ -93,3 +93,4 @@ static const adc_conf_t adc_config[] = {4, 5, 6, 7};
#endif
#endif /* PERIPH_CONF_H */
/** @} */

1
boards/z1/include/periph_conf.h
View File

@ -89,3 +89,4 @@ extern "C" {
#endif
#endif /* PERIPH_CONF_H */
/** @} */

1
boards/zigduino/include/board.h
View File

@ -46,6 +46,7 @@ extern "C" {
/**
* @name Grove PIR Motion sensor
* @{
*/
#define PIR_MOTION_PIN GPIO_PIN(PORT_D, 4)
#define PIR_MOTION_MODE GPIO_IN_PU

2
cpu/kinetis/include/mcg.h
View File

@ -8,7 +8,7 @@
*/
/* please doxygen by hiding dangling references */
#if defined(MODULE_PERIPH_MCG) || defined(MODULE_PERIPH_MCG_LITE)
#if defined(MODULE_PERIPH_MCG) || defined(MODULE_PERIPH_MCG_LITE) || defined(DOXYGEN)
/**
* @defgroup cpu_kinetis_mcg Kinetis MCG
* @ingroup cpu_kinetis

1
cpu/lpc23xx/include/periph_cpu.h
View File

@ -31,6 +31,7 @@ extern "C" {
* @{
*/
#define __IO volatile
/** @} */
/**
* @name Power mode configuration

1
cpu/nrf52/include/periph_cpu.h
View File

@ -127,6 +127,7 @@ typedef enum {
/**
* @brief I2C (TWI) configuration options
* @{
*/
typedef struct {
NRF_TWIM_Type *dev; /**< TWIM hardware device */

1
cpu/nrf9160/include/periph_cpu.h
View File

@ -100,6 +100,7 @@ typedef enum {
/**
* @brief I2C (TWI) configuration options
* @{
*/
typedef struct {
NRF_TWIM_Type *dev; /**< TWIM hardware device */

1
cpu/qn908x/include/periph_cpu.h
View File

@ -328,7 +328,6 @@ typedef enum {
* lines in the board, just using different adc_conf_t entries.
*/
typedef uint16_t adc_conf_t;
/** @} */
/**
* @brief CPU specific timer Counter/Timers (CTIMER) configuration

3
dist/tools/doccheck/check.sh vendored
View File

@ -13,6 +13,7 @@
SCRIPTDIR="$(cd "$(dirname "$0")"; pwd)"
RIOTBASE="$(cd "${SCRIPTDIR}"/../../..; pwd)"
EXCLUDE_PATTERN_FILE="${SCRIPTDIR}/exclude_patterns"
GENERIC_EXCLUDE_PATTERN_FILE="${SCRIPTDIR}/generic_exclude_patterns"
. "${RIOTBASE}"/dist/tools/ci/github_annotate.sh
@ -28,7 +29,7 @@ else
CRESET=
fi
DOXY_OUTPUT=$(make -C "${RIOTBASE}" doc 2>&1 | grep -Evf "${EXCLUDE_PATTERN_FILE}")
DOXY_OUTPUT=$(make -C "${RIOTBASE}" doc 2>&1 | grep -Evf "${EXCLUDE_PATTERN_FILE}" -f"${GENERIC_EXCLUDE_PATTERN_FILE}")
DOXY_ERRCODE=$?
RESULT=0

328
dist/tools/doccheck/exclude_patterns vendored
View File

File diff suppressed because it is too large Load Diff

19
dist/tools/doccheck/generic_exclude_patterns vendored Normal file
View File

@ -0,0 +1,19 @@
warning: Member BTN[0-9]_INT_FLANK \(macro definition\) of
warning: Member BTN[0-9]_MASK \(macro definition\) of
warning: Member BTN[0-9]_MODE \(macro definition\) of
warning: Member BTN[0-9]_PIN \(macro definition\) of
warning: Member BTN[0-9]_PORT \(macro definition\) of
warning: Member BTN[0-9]_PRESSED \(macro definition\) of
warning: Member BTN[0-9]_RELEASED \(macro definition\) of
warning: Member LED[0-9]_ENABLE_PORT \(macro definition\) of
warning: Member LED[0-9]_IS_INVERTED \(macro definition\) of
warning: Member LED[0-9]_MASK \(macro definition\) of
warning: Member LED[0-9]_MODE \(macro definition\) of
warning: Member LED[0-9]_NAME \(macro definition\) of
warning: Member LED[0-9]_OFF \(macro definition\) of
warning: Member LED[0-9]_ON \(macro definition\) of
warning: Member LED[0-9]_PIN \(macro definition\) of
warning: Member LED[0-9]_PIN_NUM \(macro definition\) of
warning: Member LED[0-9]_PORT \(macro definition\) of
warning: Member LED[0-9]_PORT_NUM \(macro definition\) of
warning: Member LED[0-9]_TOGGLE \(macro definition\) of

1
drivers/ads101x/include/ads101x_regs.h
View File

@ -98,6 +98,7 @@ extern "C" {
#define ADS101X_DATAR_1600 ((1 << 7) | (0 << 6) | (0 << 5))
#define ADS101X_DATAR_2400 ((1 << 7) | (0 << 6) | (1 << 5))
#define ADS101X_DATAR_3300 ((1 << 7) | (1 << 6) | (0 << 5))
/** @} */
#ifdef __cplusplus
}

3
drivers/at25xxx/include/at25xxx_params.h
View File

@ -14,7 +14,6 @@
* @brief Default configuration for the M95M01 EEPROM
*
* @author Benjamin Valentin <benjamin.valentin@ml-pa.com>
* @}
*/
#ifndef AT25XXX_PARAMS_H
@ -65,6 +64,7 @@ extern "C" {
.size = AT25XXX_PARAM_SIZE, \
.page_size = AT25XXX_PARAM_PAGE_SIZE }
#endif
/** @} */
/**
* @brief AT25XXX configuration
@ -79,3 +79,4 @@ static const at25xxx_params_t at25xxx_params[] =
#endif
#endif /* AT25XXX_PARAMS_H */
/** @} */

1
drivers/at86rf215/include/at86rf215_netdev.h
View File

@ -14,7 +14,6 @@
* @brief Netdev interface to AT86RF215 driver
*
* @author Benjamin Valentin <benjamin.valentin@ml-pa.com>
* @}
*/
#ifndef AT86RF215_NETDEV_H

1
drivers/at86rf215/include/at86rf215_params.h
View File

@ -14,7 +14,6 @@
* @brief Default configuration for the AT86RF215 driver
*
* @author Benjamin Valentin <benjamin.valentin@ml-pa.com>
* @}
*/
#ifndef AT86RF215_PARAMS_H

4
drivers/at86rf215/include/at86rf215_registers.h
View File

@ -14,7 +14,6 @@
* @brief Register Definitions for the AT86RF215 chip
*
* @author Benjamin Valentin <benjamin.valentin@ml-pa.com>
* @}
*/
#ifndef AT86RF215_REGISTERS_H
@ -609,10 +608,9 @@ static const struct at86rf215_BBC_regs BBC1_regs = {
/** Lower values increase the preamble detector sensitivity. */
#define FSKC3_PDT(n) (((n) << FSKC3_PDT_SHIFT) & FSKC3_PDT_MASK)
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AT86RF215_REGISTERS_H */
/** @} */

2
drivers/at86rf2xx/include/at86rf2xx_registers.h
View File

@ -170,6 +170,7 @@ extern "C" {
/* Map TX_END and RX_END to TRX_END to be compatible to SPI Devices */
#define AT86RF2XX_IRQ_STATUS_MASK__TRX_END (0x48)
/** @} */
/**
* @name Bitfield definitions for the IRQ_MASK1/IRQ_STATUS1 register
@ -532,6 +533,7 @@ extern "C" {
#define AT86RF2XX_TRX_RPC_MASK__PLL_RPC_EN (0x08)
#define AT86RF2XX_TRX_RPC_MASK__XAH_TX_RPC_EN (0x04)
#define AT86RF2XX_TRX_RPC_MASK__IPAN_RPC_EN (0x02)
/** @} */
/**
* @brief Bits to set to enable smart idle

1
drivers/ata8520e/include/ata8520e_internals.h
View File

@ -85,3 +85,4 @@ extern "C" {
#endif
#endif /* ATA8520E_INTERNALS_H */
/** @} */

1
drivers/ata8520e/include/ata8520e_params.h
View File

@ -72,3 +72,4 @@ static const ata8520e_params_t ata8520e_params[] =
#endif
#endif /* ATA8520E_PARAMS_H */
/** @} */

5
drivers/cc2420/include/cc2420_registers.h
View File

@ -36,7 +36,7 @@ extern "C" {
/** @} */
/**
* @name Possible device state change commands
* @name device state change commands
* @{
*/
enum {
@ -46,9 +46,11 @@ enum {
CC2420_GOTO_TXON, /**< transmit packet without CCA */
CC2420_GOTO_TXONCCA /**< transmit packet using CCA */
};
/** @} */
/**
* @name (Selected) device states
* @{
*/
enum {
CC2420_STATE_PD = 0, /**< power down */
@ -57,6 +59,7 @@ enum {
CC2420_STATE_RX_SEARCH = 6, /**< receive SFD search */
CC2420_STATE_RX_OVERFLOW = 17 /**< receive buffer overflow */
};
/** @} */
/**
* @name CC2420 SPI commands

3
drivers/dac_dds/include/dac_dds_params.h
View File

@ -14,7 +14,6 @@
* @brief Default configuration for the DAC DDS driver
*
* @author Benjamin Valentin <benpicco@beuth-hochschule.de>
* @}
*/
#ifndef DAC_DDS_PARAMS_H
@ -47,7 +46,7 @@ extern "C" {
.timer_hz = DAC_DDS_PARAM_TIMER_HZ, \
}
#endif
/**@}*/
/** @} */
/**
* @brief DAC DDS configuration

1
drivers/enc28j60/include/enc28j60_params.h
View File

@ -56,7 +56,6 @@ extern "C" {
static const enc28j60_params_t enc28j60_params[] = {
ENC28J60_PARAMS
};
/** @} */
#ifdef __cplusplus
}

3
drivers/encx24j600/include/encx24j600_defines.h
View File

@ -194,7 +194,8 @@ extern "C" {
/** @} */
/**
* @name ERXFCON bits
* @brief ERXFCON bits
* @{
*/
#define ENC_MCEN (1<<1)
/** @} */

1
drivers/ethos/include/ethos_params.h
View File

@ -29,7 +29,6 @@ extern "C" {
#define ETHOS_PARAMS { .uart = ETHOS_UART, \
.baudrate = ETHOS_BAUDRATE }
#endif
/** @} */
/**
* @brief ethos configuration

4
drivers/grove_ledbar/include/grove_ledbar_params.h
View File

@ -34,14 +34,14 @@ extern "C"
* @brief Clock GPIO pin
*/
#ifndef GROVE_LEDBAR_CLK
#define GROVE_LEDBAR_CLK (GPIO_PIN(0,1))
#define GROVE_LEDBAR_CLK (GPIO_PIN(0, 1))
#endif
/**
* @brief Data GPIO pin
*/
#ifndef GROVE_LEDBAR_DAT
#define GROVE_LEDBAR_DAT (GPIO_PIN(0,2))
#define GROVE_LEDBAR_DAT (GPIO_PIN(0, 2))
#endif
/**

1
drivers/hmc5883l/include/hmc5883l_regs.h
View File

@ -73,3 +73,4 @@ extern "C"
#endif
#endif /* HMC5883L_REGS_H */
/** @} */

1
drivers/include/at86rf215.h
View File

@ -298,6 +298,7 @@ typedef enum {
AT86RF215_CLKO_2_MHz, /**< 2 MHz */
AT86RF215_CLKO_1_MHz, /**< 1 MHz */
} at86rf215_clko_freq_t;
/** @} */
/**
* @name Internal device option flags

1
drivers/include/at86rf2xx.h
View File

@ -263,7 +263,6 @@ typedef struct {
/* Only radios with the XAH_CTRL_2 register support frame retry reporting */
int8_t tx_retries; /**< Number of NOACK retransmissions */
#endif
/** @} */
} at86rf2xx_t;
/**

Some files were not shown because too many files have changed in this diff Show More