Merge pull request #6489 from aabadie/fix_at_brief

boards: fix doxygen @brief in periph.conf
RIOT-OS · Jan 31, 2017 · dbc3f5f · dbc3f5f
2 parents de4d700 + ebc35a0
commit dbc3f5f
Show file tree

Hide file tree

Showing 51 changed files with 168 additions and 163 deletions.
diff --git a/boards/airfy-beacon/include/periph_conf.h b/boards/airfy-beacon/include/periph_conf.h
@@ -96,7 +96,7 @@ static const spi_conf_t spi_config[] = {
 /** @} */
 
 /**
- * @brief   I2C (TWI) configuration
+ * @name   I2C (TWI) configuration
  * @{
  */
 static const i2c_conf_t i2c_config[] = {
@@ -118,7 +118,7 @@ static const i2c_conf_t i2c_config[] = {
 /** @} */
 
 /**
- * @brief   ADC configuration
+ * @name   ADC configuration
  *
  * The configuration consists simply of a list of channels that should be used
  * @{

diff --git a/boards/arduino-common/include/periph_conf.h b/boards/arduino-common/include/periph_conf.h
@@ -34,7 +34,7 @@ extern "C" {
 /** @} */
 
 /**
- * @brief   Timer configuration
+ * @name   Timer configuration
  *
  * The timer driver only supports the 16-bit timer (Timer1)
  * so this is the only one we can use here.
@@ -51,7 +51,7 @@ extern "C" {
 /** @} */
 
 /**
- * @brief   UART configuration
+ * @name   UART configuration
  *
  * Uno has only one UART, look in atmega_common
  * This is where magic happens
@@ -65,7 +65,7 @@ extern "C" {
 /** @} */
 
 /**
- * @brief 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-mega2560/include/periph_conf.h b/boards/arduino-mega2560/include/periph_conf.h
@@ -33,7 +33,7 @@ extern "C" {
 /** @} */
 
 /**
- * @brief   Timer configuration
+ * @name   Timer configuration
  *
  * The timer driver only supports the four 16-bit timers (Timer1, Timer3,
  * Timer4, Timer5), so those are the only onces we can use here.
@@ -58,7 +58,7 @@ extern "C" {
 /** @} */
 
 /**
- * @brief   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
@@ -82,7 +82,7 @@ extern "C" {
 /** @} */
 
 /**
- * @brief 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/avsextrem/include/periph_conf.h b/boards/avsextrem/include/periph_conf.h
@@ -26,7 +26,7 @@ extern "C" {
 #endif
 
 /**
- * @brief   Clock configuration
+ * @name   Clock configuration
  * @{
  */
 #define CLOCK_CORECLOCK     (72000000U)         /* this board runs with 72MHz */
@@ -35,28 +35,33 @@ extern "C" {
 /** @} */
 
 /**
- * @brief   Timer configuration, select a number from 1 to 4
+ * @name   Timer configuration, select a number from 1 to 4
  * @{
  */
 #define TIMER_NUMOF         (1U)
 /** @} */
 
 /**
- * @brief Real Time Clock configuration
+ * @name Real Time Clock configuration
  */
-#define RTC_NUMOF           (1)
+#define RTC_NUMOF           (1U)
+/** @} */
 
 /**
- * @brief uart configuration
+ * @name UART configuration
+ * @{
  */
-#define UART_NUMOF          (1)
+#define UART_NUMOF          (1U)
 #define UART_0_EN           (1)
+/** @} */
 
 /**
- * @brief SPI configuration
+ * @name   SPI configuration
+ * @{
  */
-#define SPI_NUMOF           (1)
+#define SPI_NUMOF           (1U)
 #define SPI_0_EN            (1)
+/** @} */
 
 #ifdef __cplusplus
 }

diff --git a/boards/calliope-mini/include/periph_conf.h b/boards/calliope-mini/include/periph_conf.h
@@ -86,7 +86,7 @@ static const timer_conf_t timer_config[] = {
 /** @} */
 
 /**
- * @brief   UART configuration
+ * @name   UART configuration
  * @{
  */
 #define UART_NUMOF          (1U)
@@ -97,7 +97,7 @@ static const timer_conf_t timer_config[] = {
 /** @} */
 
 /**
- * @brief   I2C (TWI) configuration
+ * @name   I2C (TWI) configuration
  * @{
  */
 static const i2c_conf_t i2c_config[] = {
@@ -113,7 +113,7 @@ static const i2c_conf_t i2c_config[] = {
 /** @} */
 
 /**
- * @brief   ADC configuration
+ * @name   ADC configuration
  *
  * The configuration consists simply of a list of channels that should be used
  * @{

diff --git a/boards/cc2650stk/include/periph_conf.h b/boards/cc2650stk/include/periph_conf.h
@@ -34,7 +34,7 @@ extern "C" {
 /** @} */
 
 /**
- * @brief   Timer configuration
+ * @name   Timer configuration
  * @{
  */
 static const timer_conf_t timer_config[] = {
@@ -55,7 +55,7 @@ static const timer_conf_t timer_config[] = {
 /** @} */
 
 /**
- * @brief   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/periph_conf.h b/boards/chronos/include/periph_conf.h
@@ -36,7 +36,7 @@ extern "C" {
 /** @} */
 
 /**
- * @brief   Timer configuration
+ * @name   Timer configuration
  * @{
  */
 #define TIMER_NUMOF         (1U)
@@ -47,7 +47,7 @@ extern "C" {
 /** @} */
 
 /**
- * @brief   UART configuration
+ * @name   UART configuration
  * @{
  */
 #define UART_NUMOF          (1U)

diff --git a/boards/ek-lm4f120xl/include/periph_conf.h b/boards/ek-lm4f120xl/include/periph_conf.h
@@ -93,7 +93,7 @@ extern "C" {
 /** @} */
 
 /**
- * @brief   ADC configuration
+ * @name   ADC configuration
  * @{
  */
 #define ADC_NUMOF           (12)

diff --git a/boards/f4vi1/include/periph_conf.h b/boards/f4vi1/include/periph_conf.h
@@ -51,7 +51,7 @@ extern "C" {
 /** @} */
 
 /**
- * @brief   Timer configuration
+ * @name   Timer configuration
  * @{
  */
 static const timer_conf_t timer_config[] = {
@@ -78,7 +78,7 @@ static const timer_conf_t timer_config[] = {
 /** @} */
 
 /**
- * @brief   UART configuration
+ * @name   UART configuration
  * @{
  */
 static const uart_conf_t uart_config[] = {
@@ -105,14 +105,14 @@ static const uart_conf_t uart_config[] = {
 /** @} */
 
 /**
- * @brief   ADC configuration
+ * @name   ADC configuration
  * @{
  */
 #define ADC_NUMOF           (0)
 /** @} */
 
 /**
- * @brief   DAC configuration
+ * @name   DAC configuration
  * @{
  */
 #define DAC_NUMOF           (0)

diff --git a/boards/fox/include/periph_conf.h b/boards/fox/include/periph_conf.h
@@ -52,14 +52,14 @@ extern "C" {
 /** @} */
 
 /**
- * @brief   DAC configuration
+ * @name   DAC configuration
  * @{
  */
 #define DAC_NUMOF           (0)
 /** @} */
 
 /**
- * @brief   Timer configuration
+ * @name   Timer configuration
  * @{
  */
 static const timer_conf_t timer_config[] = {
@@ -86,7 +86,7 @@ static const timer_conf_t timer_config[] = {
 /** @} */
 
 /**
- * @brief   UART configuration
+ * @name   UART configuration
  * @{
  */
 static const uart_conf_t uart_config[] = {
@@ -115,7 +115,7 @@ static const uart_conf_t uart_config[] = {
 /** @} */
 
 /**
- * @brief   SPI configuration
+ * @name   SPI configuration
  *
  * @note    The spi_divtable is auto-generated from
  *          `cpu/stm32_common/dist/spi_divtable/spi_divtable.c`

diff --git a/boards/iotlab-a8-m3/include/periph_conf.h b/boards/iotlab-a8-m3/include/periph_conf.h
@@ -28,7 +28,7 @@ extern "C" {
 #endif
 
 /**
- * @brief SPI configuration
+ * @name   SPI configuration
  * @{
  */
 static const spi_conf_t spi_config[] = {

diff --git a/boards/iotlab-m3/include/periph_conf.h b/boards/iotlab-m3/include/periph_conf.h
@@ -28,7 +28,7 @@ extern "C" {
 #endif
 
 /**
- * @brief SPI configuration
+ * @name   SPI configuration
  * @{
  */
 static const spi_conf_t spi_config[] = {

diff --git a/boards/limifrog-v1/include/periph_conf.h b/boards/limifrog-v1/include/periph_conf.h
@@ -50,14 +50,14 @@ extern "C" {
 /** @} */
 
 /**
- * @brief   DAC configuration
+ * @name   DAC configuration
  * @{
  */
 #define DAC_NUMOF           (0)
 /** @} */
 
 /**
- * @brief Timer configuration
+ * @name   Timer configuration
  * @{
  */
 static const timer_conf_t timer_config[] = {
@@ -76,7 +76,7 @@ static const timer_conf_t timer_config[] = {
 /** @} */
 
 /**
- * @brief   UART configuration
+ * @name   UART configuration
  * @{
  */
 static const uart_conf_t uart_config[] = {
@@ -109,7 +109,7 @@ static const uart_conf_t uart_config[] = {
 /** @} */
 
 /**
- * @brief   SPI configuration
+ * @name   SPI configuration
  *
  * @note    The spi_divtable is auto-generated from
  *          `cpu/stm32_common/dist/spi_divtable/spi_divtable.c`

diff --git a/boards/maple-mini/include/periph_conf.h b/boards/maple-mini/include/periph_conf.h
@@ -57,14 +57,14 @@ extern "C" {
 /** @} */
 
 /**
- * @brief   DAC configuration
+ * @name   DAC configuration
  * @{
  */
 #define DAC_NUMOF           (0)
 /** @} */
 
 /**
- * @brief   Timer configuration
+ * @name   Timer configuration
  * @{
  */
 static const timer_conf_t timer_config[] = {
@@ -91,7 +91,7 @@ static const timer_conf_t timer_config[] = {
 /** @} */
 
 /**
- * @brief UART configuration
+ * @name   UART configuration
  * @{
  */
 static const uart_conf_t uart_config[] = {

diff --git a/boards/mbed_lpc1768/include/periph_conf.h b/boards/mbed_lpc1768/include/periph_conf.h
@@ -24,7 +24,7 @@ extern "C" {
 #endif
 
 /**
- * @brief Timer configuration
+ * @name   Timer configuration
  * @{
  */
 #define TIMER_NUMOF         (1U)
@@ -44,7 +44,7 @@ extern "C" {
 /** @} */
 
 /**
- * @brief UART configuration
+ * @name   UART configuration
  * @{
  */
 #define UART_NUMOF          (2U)

diff --git a/boards/microbit/include/periph_conf.h b/boards/microbit/include/periph_conf.h
@@ -86,7 +86,7 @@ static const timer_conf_t timer_config[] = {
 /** @} */
 
 /**
- * @brief   UART configuration
+ * @name   UART configuration
  * @{
  */
 #define UART_NUMOF          (1U)
@@ -97,7 +97,7 @@ static const timer_conf_t timer_config[] = {
 /** @} */
 
 /**
- * @brief   I2C (TWI) configuration
+ * @name   I2C (TWI) configuration
  * @{
  */
 static const i2c_conf_t i2c_config[] = {
@@ -113,7 +113,7 @@ static const i2c_conf_t i2c_config[] = {
 /** @} */
 
 /**
- * @brief   ADC configuration
+ * @name   ADC configuration
  *
  * The configuration consists simply of a list of channels that should be used
  * @{