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

doc: fix unbalaced grouping

- most were trivial
    - missing group close or open
    - extra space
    - no doxygen comment
- name commad might open an implicit group
    this hould also be implicit cosed but does not happen somtimes
- crazy: internal declared groups have to be closed internal
This commit is contained in:
Karl Fessel 2022-08-11 16:24:37 +02:00
parent 4e5931b56a
commit 05f114d0af
146 changed files with 365 additions and 284 deletions

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -73,3 +73,4 @@ static const spi_conf_t spi_config[] = {
#endif #endif
#endif /* PERIPH_CONF_H */ #endif /* 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), .int_pin = GPIO_PIN(PD, 12),
} }
}; };
/** @} */
#ifdef __cplusplus #ifdef __cplusplus
} }

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -8,7 +8,7 @@
*/ */
/* please doxygen by hiding dangling references */ /* 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 * @defgroup cpu_kinetis_mcg Kinetis MCG
* @ingroup cpu_kinetis * @ingroup cpu_kinetis

View File

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

View File

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

View File

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

View File

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

View File

@ -13,6 +13,7 @@
SCRIPTDIR="$(cd "$(dirname "$0")"; pwd)" SCRIPTDIR="$(cd "$(dirname "$0")"; pwd)"
RIOTBASE="$(cd "${SCRIPTDIR}"/../../..; pwd)" RIOTBASE="$(cd "${SCRIPTDIR}"/../../..; pwd)"
EXCLUDE_PATTERN_FILE="${SCRIPTDIR}/exclude_patterns" EXCLUDE_PATTERN_FILE="${SCRIPTDIR}/exclude_patterns"
GENERIC_EXCLUDE_PATTERN_FILE="${SCRIPTDIR}/generic_exclude_patterns"
. "${RIOTBASE}"/dist/tools/ci/github_annotate.sh . "${RIOTBASE}"/dist/tools/ci/github_annotate.sh
@ -28,7 +29,7 @@ else
CRESET= CRESET=
fi 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=$? DOXY_ERRCODE=$?
RESULT=0 RESULT=0

File diff suppressed because it is too large Load Diff

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

View File

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

View File

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

View File

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

View File

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

View File

@ -14,7 +14,6 @@
* @brief Register Definitions for the AT86RF215 chip * @brief Register Definitions for the AT86RF215 chip
* *
* @author Benjamin Valentin <benjamin.valentin@ml-pa.com> * @author Benjamin Valentin <benjamin.valentin@ml-pa.com>
* @}
*/ */
#ifndef AT86RF215_REGISTERS_H #ifndef AT86RF215_REGISTERS_H
@ -609,10 +608,9 @@ static const struct at86rf215_BBC_regs BBC1_regs = {
/** Lower values increase the preamble detector sensitivity. */ /** Lower values increase the preamble detector sensitivity. */
#define FSKC3_PDT(n) (((n) << FSKC3_PDT_SHIFT) & FSKC3_PDT_MASK) #define FSKC3_PDT(n) (((n) << FSKC3_PDT_SHIFT) & FSKC3_PDT_MASK)
/** @} */
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
#endif /* AT86RF215_REGISTERS_H */ #endif /* AT86RF215_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 */ /* Map TX_END and RX_END to TRX_END to be compatible to SPI Devices */
#define AT86RF2XX_IRQ_STATUS_MASK__TRX_END (0x48) #define AT86RF2XX_IRQ_STATUS_MASK__TRX_END (0x48)
/** @} */
/** /**
* @name Bitfield definitions for the IRQ_MASK1/IRQ_STATUS1 register * @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__PLL_RPC_EN (0x08)
#define AT86RF2XX_TRX_RPC_MASK__XAH_TX_RPC_EN (0x04) #define AT86RF2XX_TRX_RPC_MASK__XAH_TX_RPC_EN (0x04)
#define AT86RF2XX_TRX_RPC_MASK__IPAN_RPC_EN (0x02) #define AT86RF2XX_TRX_RPC_MASK__IPAN_RPC_EN (0x02)
/** @} */
/** /**
* @brief Bits to set to enable smart idle * @brief Bits to set to enable smart idle

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -15,7 +15,6 @@
* *
* @author Vitor Batista <vitor.batista@ml-pa.com> * @author Vitor Batista <vitor.batista@ml-pa.com>
* *
* @}
*/ */
/** /**

View File

@ -166,6 +166,8 @@ extern "C"
#define TMP00X_CONFIG_CR_AS8 (0x03) /**< Conversion Time 2s, AVG Samples: 8 */ #define TMP00X_CONFIG_CR_AS8 (0x03) /**< Conversion Time 2s, AVG Samples: 8 */
#define TMP00X_CONFIG_CR_AS16 (0x04) /**< Conversion Time 4s, AVG Samples: 16 */ #define TMP00X_CONFIG_CR_AS16 (0x04) /**< Conversion Time 4s, AVG Samples: 16 */
#define TMP00X_CONFIG_CR_DEF TMP00X_CONFIG_CR_AS4 /**< Default for Testing */ #define TMP00X_CONFIG_CR_DEF TMP00X_CONFIG_CR_AS4 /**< Default for Testing */
/** @} */
/** /**
* @name Constants for TMP00X calibration * @name Constants for TMP00X calibration

View File

@ -30,11 +30,13 @@ extern "C" {
/** /**
* @name usbdev mock device endpoint states * @name usbdev mock device endpoint states
* @{
*/ */
typedef enum { typedef enum {
EP_STATE_READY, /**< Endpoint is ready/idle */ EP_STATE_READY, /**< Endpoint is ready/idle */
EP_STATE_DATA_AVAILABLE, /**< Endpoint has data */ EP_STATE_DATA_AVAILABLE, /**< Endpoint has data */
} usbdev_mock_ep_state_t; } usbdev_mock_ep_state_t;
/** @} */
/** /**
* @brief usbdev mock device endpoint * @brief usbdev mock device endpoint
@ -114,4 +116,3 @@ void usbdev_mock_setup(usbdev_mock_esr_cb_t esr_cb,
#endif /* USBDEV_MOCK_H */ #endif /* USBDEV_MOCK_H */
/** @} */ /** @} */
/** @} */

View File

@ -87,4 +87,4 @@ void w5100_setup(w5100_t *dev, const w5100_params_t *params, uint8_t index);
#endif #endif
#endif /* W5100_H */ #endif /* W5100_H */
/* @} */ /** @} */

View File

@ -72,3 +72,4 @@ extern "C"
#endif #endif
#endif /* ITG320X_REGS_H */ #endif /* ITG320X_REGS_H */
/** @} */

View File

@ -74,6 +74,7 @@
/** /**
* @name CTRL4 bitfields * @name CTRL4 bitfields
* @{
*/ */
#define L3G4200D_CTRL4_BDU 0x80 #define L3G4200D_CTRL4_BDU 0x80
#define L3G4200D_CTRL4_BLE 0x40 #define L3G4200D_CTRL4_BLE 0x40

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