From 800fac5be44086770492158d0d5465d9624c2bdf Mon Sep 17 00:00:00 2001 From: smlng Date: Thu, 30 Nov 2017 23:34:07 +0100 Subject: [PATCH 01/15] boards/common: enhance doxygen for arduino-atmega --- boards/common/arduino-atmega/board.c | 2 +- boards/common/arduino-atmega/doc.txt | 13 ------------- .../common/arduino-atmega/include/arduino_board.h | 2 +- .../common/arduino-atmega/include/arduino_pinmap.h | 2 +- boards/common/arduino-atmega/include/board_common.h | 4 +++- boards/common/arduino-atmega/include/gpio_params.h | 2 +- boards/common/arduino-atmega/include/periph_conf.h | 2 +- 7 files changed, 8 insertions(+), 19 deletions(-) delete mode 100644 boards/common/arduino-atmega/doc.txt diff --git a/boards/common/arduino-atmega/board.c b/boards/common/arduino-atmega/board.c index 3bf9296d37..33afa0e9b3 100644 --- a/boards/common/arduino-atmega/board.c +++ b/boards/common/arduino-atmega/board.c @@ -9,7 +9,7 @@ */ /** - * @ingroup boards_arduino-atmega-common + * @ingroup boards_common_arduino-atmega * @{ * * @file diff --git a/boards/common/arduino-atmega/doc.txt b/boards/common/arduino-atmega/doc.txt deleted file mode 100644 index c4508e5adf..0000000000 --- a/boards/common/arduino-atmega/doc.txt +++ /dev/null @@ -1,13 +0,0 @@ -/* - * Copyright (C) 2017 HAW Hamburg - * - * This file is subject to the terms and conditions of the GNU Lesser - * General Public License v2.1. See the file LICENSE in the top level - * directory for more details. - */ - -/** - * @defgroup boards_arduino-atmega-common Arduino Atmega Common - * @ingroup boards - * @brief Common configuration and settings for Arduino Atmega boards - */ diff --git a/boards/common/arduino-atmega/include/arduino_board.h b/boards/common/arduino-atmega/include/arduino_board.h index de5c4c82df..a9397676fe 100644 --- a/boards/common/arduino-atmega/include/arduino_board.h +++ b/boards/common/arduino-atmega/include/arduino_board.h @@ -7,7 +7,7 @@ */ /** - * @ingroup boards_arduino-atmega-common + * @ingroup boards_common_arduino-atmega * @{ * * @file diff --git a/boards/common/arduino-atmega/include/arduino_pinmap.h b/boards/common/arduino-atmega/include/arduino_pinmap.h index 842a2d72bd..98d5b2bb5c 100644 --- a/boards/common/arduino-atmega/include/arduino_pinmap.h +++ b/boards/common/arduino-atmega/include/arduino_pinmap.h @@ -8,7 +8,7 @@ */ /** - * @ingroup boards_arduino-atmega-common + * @ingroup boards_common_arduino-atmega * @{ * * @file diff --git a/boards/common/arduino-atmega/include/board_common.h b/boards/common/arduino-atmega/include/board_common.h index bc78749d99..be77f2cf2c 100644 --- a/boards/common/arduino-atmega/include/board_common.h +++ b/boards/common/arduino-atmega/include/board_common.h @@ -8,7 +8,9 @@ */ /* - * @ingroup boards_arduino-atmega-common + * @defgroup boards_common_arduino-atmega Arduino Atmega Common + * @ingroup boards_common + * @brief Shared files and configuration for Arduino Atmega boards. * @{ * * @file diff --git a/boards/common/arduino-atmega/include/gpio_params.h b/boards/common/arduino-atmega/include/gpio_params.h index d703508765..1cf28a85fd 100644 --- a/boards/common/arduino-atmega/include/gpio_params.h +++ b/boards/common/arduino-atmega/include/gpio_params.h @@ -7,7 +7,7 @@ */ /** - * @ingroup boards_arduino-atmega-common + * @ingroup boards_common_arduino-atmega * @{ * * @file diff --git a/boards/common/arduino-atmega/include/periph_conf.h b/boards/common/arduino-atmega/include/periph_conf.h index b3506efdcb..52d1c345ac 100644 --- a/boards/common/arduino-atmega/include/periph_conf.h +++ b/boards/common/arduino-atmega/include/periph_conf.h @@ -9,7 +9,7 @@ */ /** - * @ingroup boards_arduino-atmega-common + * @ingroup boards_common_arduino-atmega * @{ * * @file From 779979bab53a941c8a41be84eda4a299d83c08c5 Mon Sep 17 00:00:00 2001 From: smlng Date: Thu, 30 Nov 2017 23:34:41 +0100 Subject: [PATCH 02/15] boards/common: enhance doxygen for arduino-due --- boards/common/arduino-due/include/board.h | 6 +++--- boards/common/arduino-due/include/gpio_params.h | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/boards/common/arduino-due/include/board.h b/boards/common/arduino-due/include/board.h index a5e86a5ab4..cdc1f5cf9b 100644 --- a/boards/common/arduino-due/include/board.h +++ b/boards/common/arduino-due/include/board.h @@ -7,9 +7,9 @@ */ /** - * @defgroup boards_common_arduino_due Shared Arduino Due Code - * @ingroup boards - * @brief Shared code for Arduino Due based boards + * @defgroup boards_common_arduino_due Arduino Due Common + * @ingroup boards_common + * @brief Shared files and configuration for Arduino Due based boards. * @{ * * @file diff --git a/boards/common/arduino-due/include/gpio_params.h b/boards/common/arduino-due/include/gpio_params.h index f3c7d9d165..79273cb9fd 100644 --- a/boards/common/arduino-due/include/gpio_params.h +++ b/boards/common/arduino-due/include/gpio_params.h @@ -7,13 +7,13 @@ */ /** - * @ingroup boards_common_arduino_due + * @ingroup boards_common_arduino_due * @{ * * @file - * @brief Board specific configuration of direct mapped GPIOs + * @brief Board specific configuration of direct mapped GPIOs * - * @author Hauke Petersen + * @author Hauke Petersen */ #ifndef GPIO_PARAMS_H From f29b01ebe3b0e4f94fce9fdf8644a8f702d10d5d Mon Sep 17 00:00:00 2001 From: smlng Date: Thu, 30 Nov 2017 23:34:55 +0100 Subject: [PATCH 03/15] boards/common: enhance doxygen for arduino-mkr --- boards/common/arduino-mkr/board.c | 5 +++-- boards/common/arduino-mkr/include/arduino_board.h | 2 +- boards/common/arduino-mkr/include/arduino_pinmap.h | 2 +- boards/common/arduino-mkr/include/board_common.h | 6 +++--- boards/common/arduino-mkr/include/gpio_params.h | 8 ++++---- boards/common/arduino-mkr/include/periph_conf.h | 2 +- 6 files changed, 13 insertions(+), 12 deletions(-) diff --git a/boards/common/arduino-mkr/board.c b/boards/common/arduino-mkr/board.c index 939d06ced8..c78e883681 100644 --- a/boards/common/arduino-mkr/board.c +++ b/boards/common/arduino-mkr/board.c @@ -9,12 +9,13 @@ /** * @ingroup boards_arduino-mkr-common - * + * @{ * @file * @brief Board common implementations for the Arduino MKR boards * - * @author Hauke Pertersen + * @author Hauke Pertersen * @author Alexandre Abadie + * * @} */ diff --git a/boards/common/arduino-mkr/include/arduino_board.h b/boards/common/arduino-mkr/include/arduino_board.h index 41c8fc8796..4346e45194 100644 --- a/boards/common/arduino-mkr/include/arduino_board.h +++ b/boards/common/arduino-mkr/include/arduino_board.h @@ -8,7 +8,7 @@ */ /** - * @ingroup boards_arduino-mkr1000 + * @ingroup boards_common_arduino-mkr * @{ * * @file diff --git a/boards/common/arduino-mkr/include/arduino_pinmap.h b/boards/common/arduino-mkr/include/arduino_pinmap.h index b48a11f886..2c53522568 100644 --- a/boards/common/arduino-mkr/include/arduino_pinmap.h +++ b/boards/common/arduino-mkr/include/arduino_pinmap.h @@ -7,7 +7,7 @@ */ /** - * @ingroup boards_arduino-mkr-common + * @ingroup boards_common_arduino-mkr * @{ * * @file diff --git a/boards/common/arduino-mkr/include/board_common.h b/boards/common/arduino-mkr/include/board_common.h index 7208e0fdef..459a5f8898 100644 --- a/boards/common/arduino-mkr/include/board_common.h +++ b/boards/common/arduino-mkr/include/board_common.h @@ -7,9 +7,9 @@ */ /** - * @defgroup boards_arduino-mkr-common Arduino MKR Common - * @ingroup boards - * @brief Support for the Arduino MKR boards type. + * @defgroup boards_common_arduino-mkr Arduino MKR Common + * @ingroup boards_common + * @brief Shared files and configuration for the Arduino MKR boards type. * @{ * * @file diff --git a/boards/common/arduino-mkr/include/gpio_params.h b/boards/common/arduino-mkr/include/gpio_params.h index 9d573ee9ea..df0e4c9af8 100644 --- a/boards/common/arduino-mkr/include/gpio_params.h +++ b/boards/common/arduino-mkr/include/gpio_params.h @@ -8,14 +8,14 @@ */ /** - * @ingroup boards_arduino-mkr-common + * @ingroup boards_common_arduino-mkr * @{ * * @file - * @brief Board specific configuration of direct mapped GPIOs + * @brief Board specific configuration of direct mapped GPIOs * - * @author Alexandre Abadie - * @author Hauke Petersen + * @author Alexandre Abadie + * @author Hauke Petersen */ #ifndef GPIO_PARAMS_H diff --git a/boards/common/arduino-mkr/include/periph_conf.h b/boards/common/arduino-mkr/include/periph_conf.h index b13064bc45..f439b1f1b9 100644 --- a/boards/common/arduino-mkr/include/periph_conf.h +++ b/boards/common/arduino-mkr/include/periph_conf.h @@ -8,7 +8,7 @@ */ /** - * @ingroup boards_arduino-mkr-common + * @ingroup boards_common_arduino-mkr * @{ * * @file From 2a37aa265deb57c670fea1f8e39dc5ba291c1e83 Mon Sep 17 00:00:00 2001 From: smlng Date: Thu, 30 Nov 2017 23:35:34 +0100 Subject: [PATCH 04/15] boards/common: enhance doxygen for msb-430 --- boards/common/msb-430/board_init.c | 4 +--- boards/common/msb-430/drivers/include/sht11-board.h | 2 +- boards/common/msb-430/include/board_common.h | 6 +++--- 3 files changed, 5 insertions(+), 7 deletions(-) diff --git a/boards/common/msb-430/board_init.c b/boards/common/msb-430/board_init.c index ddad1485de..913449807f 100644 --- a/boards/common/msb-430/board_init.c +++ b/boards/common/msb-430/board_init.c @@ -9,15 +9,13 @@ /** * @ingroup boards * @{ - */ - -/** * @file * @brief msb-430 common board initialization * * @author Oliver Hahm * @author Kaspar Schleiser * + * @} */ #include "cpu.h" diff --git a/boards/common/msb-430/drivers/include/sht11-board.h b/boards/common/msb-430/drivers/include/sht11-board.h index 5509a67857..a79fe22b4d 100644 --- a/boards/common/msb-430/drivers/include/sht11-board.h +++ b/boards/common/msb-430/drivers/include/sht11-board.h @@ -10,7 +10,7 @@ #define SHT11_BOARD_H /** - * @ingroup msb_430h + * @ingroup boards_common_msb-430 * @{ */ diff --git a/boards/common/msb-430/include/board_common.h b/boards/common/msb-430/include/board_common.h index 299d585eda..a6d3280e94 100644 --- a/boards/common/msb-430/include/board_common.h +++ b/boards/common/msb-430/include/board_common.h @@ -7,9 +7,9 @@ */ /** - * @defgroup boards_msb430-common MSB-430 common - * @ingroup boards - * @brief Common files for all MSB-430 boards + * @defgroup boards_common_msb-430 MSB-430 common + * @ingroup boards_common + * @brief Shared files and configuration for all MSB-430 boards. * @{ * * @file From 37be1e3846e354a4b25a096ed4a50f6c6d5c797b Mon Sep 17 00:00:00 2001 From: smlng Date: Thu, 30 Nov 2017 23:36:08 +0100 Subject: [PATCH 05/15] boards/common: enhance doxygen for msb-a2 --- boards/common/msba2/board_common_init.c | 7 +++---- boards/common/msba2/include/msba2_common.h | 6 +++--- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/boards/common/msba2/board_common_init.c b/boards/common/msba2/board_common_init.c index 8e4723ac92..e2e3afb688 100644 --- a/boards/common/msba2/board_common_init.c +++ b/boards/common/msba2/board_common_init.c @@ -7,11 +7,8 @@ */ /** - * @ingroup msba2 + * @ingroup boards_common_msba2 * @{ - */ - -/** * @file * @brief MSB-A2 board initialization * @@ -20,6 +17,8 @@ * @author Michael Baar * @author Zakaria Kasmi * @note $Id$ + * + * @} */ #include #include "board.h" diff --git a/boards/common/msba2/include/msba2_common.h b/boards/common/msba2/include/msba2_common.h index de935216a6..4b9c9d3558 100644 --- a/boards/common/msba2/include/msba2_common.h +++ b/boards/common/msba2/include/msba2_common.h @@ -7,9 +7,9 @@ */ /** - * @defgroup boards_msba2-common MSB-A2 common - * @ingroup boards - * @brief Common files for all MSB-A2 based boards + * @defgroup boards_common_msba2 MSB-A2 common + * @ingroup boards_common + * @brief Shared files and configuration for all MSB-A2 boards. * @{ * * @file From a4b1ce658bac8f4776393902f4f01cae1510ff70 Mon Sep 17 00:00:00 2001 From: smlng Date: Thu, 30 Nov 2017 23:36:27 +0100 Subject: [PATCH 06/15] boards/common: enhance doxygen for nrf52 --- boards/common/nrf52xxxdk/board.c | 2 +- boards/common/nrf52xxxdk/include/board_common.h | 4 ++-- boards/common/nrf52xxxdk/include/gpio_params.h | 2 +- boards/common/nrf52xxxdk/include/periph_conf.h | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/boards/common/nrf52xxxdk/board.c b/boards/common/nrf52xxxdk/board.c index d25e9f08e9..5a4b651195 100644 --- a/boards/common/nrf52xxxdk/board.c +++ b/boards/common/nrf52xxxdk/board.c @@ -7,7 +7,7 @@ */ /** - * @ingroup boards_nrf52840dk + * @ingroup boards_common_nrf52 * @{ * * @file diff --git a/boards/common/nrf52xxxdk/include/board_common.h b/boards/common/nrf52xxxdk/include/board_common.h index 1cffcbe633..16c64abfac 100644 --- a/boards/common/nrf52xxxdk/include/board_common.h +++ b/boards/common/nrf52xxxdk/include/board_common.h @@ -7,9 +7,9 @@ */ /** - * @defgroup boards_common_nrf52 Shared nRF52 code + * @defgroup boards_common_nrf52 NRF52 common * @ingroup boards_common - * @brief Shared configuration for all nRF52-based boards + * @brief Shared files and configuration for all nRF52 boards. * @{ * * @file diff --git a/boards/common/nrf52xxxdk/include/gpio_params.h b/boards/common/nrf52xxxdk/include/gpio_params.h index 4ac68e2487..8e236f54c5 100644 --- a/boards/common/nrf52xxxdk/include/gpio_params.h +++ b/boards/common/nrf52xxxdk/include/gpio_params.h @@ -7,7 +7,7 @@ */ /** - * @ingroup boards_nrf52dk + * @ingroup boards_common_nrf52 * @{ * * @file diff --git a/boards/common/nrf52xxxdk/include/periph_conf.h b/boards/common/nrf52xxxdk/include/periph_conf.h index e9a82db84f..4242273a3b 100644 --- a/boards/common/nrf52xxxdk/include/periph_conf.h +++ b/boards/common/nrf52xxxdk/include/periph_conf.h @@ -7,7 +7,7 @@ */ /** - * @ingroup boards_nrf52dk + * @ingroup boards_common_nrf52 * @{ * * @file From c1354ac3d772db5b8c18baf2cdb4d8541f59827e Mon Sep 17 00:00:00 2001 From: smlng Date: Thu, 30 Nov 2017 23:36:42 +0100 Subject: [PATCH 07/15] boards/common: enhance doxygen for stm nucleo --- boards/common/nucleo/include/arduino_board.h | 2 +- boards/common/nucleo/include/arduino_pinmap.h | 2 +- boards/common/nucleo/include/board_common.h | 12 +++--------- boards/common/nucleo/include/gpio_params.h | 8 ++++---- 4 files changed, 9 insertions(+), 15 deletions(-) diff --git a/boards/common/nucleo/include/arduino_board.h b/boards/common/nucleo/include/arduino_board.h index 2cdd599e2d..a64307120d 100644 --- a/boards/common/nucleo/include/arduino_board.h +++ b/boards/common/nucleo/include/arduino_board.h @@ -8,7 +8,7 @@ */ /** - * @ingroup boards_nucleo-common + * @ingroup boards_common_nucleo * @{ * * @file diff --git a/boards/common/nucleo/include/arduino_pinmap.h b/boards/common/nucleo/include/arduino_pinmap.h index 75bd8aa18c..03cad25c8d 100644 --- a/boards/common/nucleo/include/arduino_pinmap.h +++ b/boards/common/nucleo/include/arduino_pinmap.h @@ -7,7 +7,7 @@ */ /** - * @ingroup boards_nucleo-common + * @ingroup boards_common_nucleo * @{ * * @file diff --git a/boards/common/nucleo/include/board_common.h b/boards/common/nucleo/include/board_common.h index e374982467..7f54386bf1 100644 --- a/boards/common/nucleo/include/board_common.h +++ b/boards/common/nucleo/include/board_common.h @@ -7,15 +7,9 @@ */ /** - * @defgroup boards_nucleo STM Nucleo boards - * @ingroup boards - * @brief STM Nucleo boards - */ - -/** - * @defgroup boards_nucleo64_common STM Nucleo 64 boards common - * @ingroup boards_nucleo - * @brief Common files for STM Nucleo 64 boards + * @defgroup boards_common_nucleo STM Nucleo common + * @ingroup boards_common + * @brief Shared files and configuration for all STM Nucleo boards. * @{ * * @file diff --git a/boards/common/nucleo/include/gpio_params.h b/boards/common/nucleo/include/gpio_params.h index 40e4db59bd..4ab49d3817 100644 --- a/boards/common/nucleo/include/gpio_params.h +++ b/boards/common/nucleo/include/gpio_params.h @@ -7,14 +7,14 @@ */ /** - * @ingroup boards_nucleo-common + * @ingroup boards_common_nucleo * @{ * * @file - * @brief Board specific configuration of direct mapped GPIOs + * @brief Board specific configuration of direct mapped GPIOs * - * @author Alexandre Abadie - * @author Sebastian Meiling + * @author Alexandre Abadie + * @author Sebastian Meiling */ #ifndef GPIO_PARAMS_H From b06b5748ece70bdd867f6ead93a496a5e601b9ee Mon Sep 17 00:00:00 2001 From: smlng Date: Thu, 30 Nov 2017 23:36:48 +0100 Subject: [PATCH 08/15] boards/common: enhance doxygen for stm nucleo32 --- boards/common/nucleo32/include/arduino_board.h | 2 +- boards/common/nucleo32/include/arduino_pinmap.h | 2 +- boards/common/nucleo32/include/board_common.h | 6 +++--- boards/common/nucleo32/include/gpio_params.h | 6 +++--- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/boards/common/nucleo32/include/arduino_board.h b/boards/common/nucleo32/include/arduino_board.h index 3d0f7bac0e..818d751de5 100644 --- a/boards/common/nucleo32/include/arduino_board.h +++ b/boards/common/nucleo32/include/arduino_board.h @@ -7,7 +7,7 @@ */ /** - * @ingroup boards_nucleo32-common + * @ingroup boards_common_nucleo32 * @{ * * @file diff --git a/boards/common/nucleo32/include/arduino_pinmap.h b/boards/common/nucleo32/include/arduino_pinmap.h index fa2ce17278..5d10a3abdd 100644 --- a/boards/common/nucleo32/include/arduino_pinmap.h +++ b/boards/common/nucleo32/include/arduino_pinmap.h @@ -7,7 +7,7 @@ */ /** - * @ingroup boards_nucleo32-common + * @ingroup boards_common_nucleo32 * @{ * * @file diff --git a/boards/common/nucleo32/include/board_common.h b/boards/common/nucleo32/include/board_common.h index 895ea0b3ee..7796f904c4 100644 --- a/boards/common/nucleo32/include/board_common.h +++ b/boards/common/nucleo32/include/board_common.h @@ -7,9 +7,9 @@ */ /** - * @defgroup boards_nucleo32-common STM Nucleo-32 Common - * @ingroup boards_nucleo - * @brief Common files for STM Nucleo-32 boards + * @defgroup boards_common_nucleo32 STM Nucleo32 common + * @ingroup boards_common + * @brief Shared files and configuration for all STM Nucleo32 boards. * @{ * * @file diff --git a/boards/common/nucleo32/include/gpio_params.h b/boards/common/nucleo32/include/gpio_params.h index fae5213270..49c91566f4 100644 --- a/boards/common/nucleo32/include/gpio_params.h +++ b/boards/common/nucleo32/include/gpio_params.h @@ -7,13 +7,13 @@ */ /** - * @ingroup boards_nucleo32-common + * @ingroup boards_common_nucleo32 * @{ * * @file - * @brief Board specific configuration of direct mapped GPIOs + * @brief Board specific configuration of direct mapped GPIOs * - * @author Alexandre Abadie + * @author Alexandre Abadie */ #ifndef GPIO_PARAMS_H From 39a5576aa7868d1d3c1d907e9c17b7036d7fc871 Mon Sep 17 00:00:00 2001 From: smlng Date: Thu, 30 Nov 2017 23:36:56 +0100 Subject: [PATCH 09/15] boards/common: enhance doxygen for stm nucleo144 --- boards/common/nucleo144/include/arduino_board.h | 2 +- boards/common/nucleo144/include/arduino_pinmap.h | 2 +- boards/common/nucleo144/include/board_common.h | 6 +++--- boards/common/nucleo144/include/gpio_params.h | 8 ++++---- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/boards/common/nucleo144/include/arduino_board.h b/boards/common/nucleo144/include/arduino_board.h index 3dae69fc9d..71624a051a 100644 --- a/boards/common/nucleo144/include/arduino_board.h +++ b/boards/common/nucleo144/include/arduino_board.h @@ -7,7 +7,7 @@ */ /** - * @ingroup boards_nucleo144-common + * @ingroup boards_common_nucleo144 * @{ * * @file diff --git a/boards/common/nucleo144/include/arduino_pinmap.h b/boards/common/nucleo144/include/arduino_pinmap.h index aceb56dbb1..678c6ab1aa 100644 --- a/boards/common/nucleo144/include/arduino_pinmap.h +++ b/boards/common/nucleo144/include/arduino_pinmap.h @@ -7,7 +7,7 @@ */ /** - * @ingroup boards_nucleo144-common + * @ingroup boards_common_nucleo144 * @{ * * @file diff --git a/boards/common/nucleo144/include/board_common.h b/boards/common/nucleo144/include/board_common.h index f4bc572cfb..3a30b92246 100644 --- a/boards/common/nucleo144/include/board_common.h +++ b/boards/common/nucleo144/include/board_common.h @@ -8,9 +8,9 @@ */ /** - * @defgroup boards_nucleo144-common STM Nucleo-144 Common - * @ingroup boards_nucleo - * @brief Common files for STM Nucleo-144 boards + * @defgroup boards_common_nucleo144 STM Nucleo144 common + * @ingroup boards_common + * @brief Shared files and configuration for all STM Nucleo144 boards. * @{ * * @file diff --git a/boards/common/nucleo144/include/gpio_params.h b/boards/common/nucleo144/include/gpio_params.h index b4e07b58ca..a688f97dbb 100644 --- a/boards/common/nucleo144/include/gpio_params.h +++ b/boards/common/nucleo144/include/gpio_params.h @@ -7,14 +7,14 @@ */ /** - * @ingroup boards_nucleo144-common + * @ingroup boards_common_nucleo144 * @{ * * @file - * @brief Board specific configuration of direct mapped GPIOs + * @brief Board specific configuration of direct mapped GPIOs * - * @author Alexandre Abadie - * @author Sebastian Meiling + * @author Alexandre Abadie + * @author Sebastian Meiling */ #ifndef GPIO_PARAMS_H From 356fe22ec5767ed154295b38d01fa17dd1891c5d Mon Sep 17 00:00:00 2001 From: smlng Date: Thu, 30 Nov 2017 23:37:13 +0100 Subject: [PATCH 10/15] boards/common: enhance doxygen for Zolertia Re-Mote --- boards/common/remote/include/board_common.h | 5 +++-- boards/common/remote/include/fancy_leds.h | 3 +-- boards/common/remote/include/periph_common.h | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/boards/common/remote/include/board_common.h b/boards/common/remote/include/board_common.h index 1837cc294e..acb1d8a6fa 100644 --- a/boards/common/remote/include/board_common.h +++ b/boards/common/remote/include/board_common.h @@ -8,8 +8,9 @@ */ /** - * @ingroup boards_remote - * @brief Support for the RE-Mote boards + * @defgroup boards_common_remote Zolertia Re-Mote common + * @ingroup boards_common + * @brief Shared files and configuration for all Zolertia Re-Mote boards. * @{ * * @file diff --git a/boards/common/remote/include/fancy_leds.h b/boards/common/remote/include/fancy_leds.h index 3fa9c83fef..0470b8128c 100644 --- a/boards/common/remote/include/fancy_leds.h +++ b/boards/common/remote/include/fancy_leds.h @@ -8,8 +8,7 @@ */ /** - * @ingroup boards_remote - * @brief LED extension + * @ingroup boards_common_remote * @{ * * @file diff --git a/boards/common/remote/include/periph_common.h b/boards/common/remote/include/periph_common.h index 98ace56fc6..e0ccfb83d8 100644 --- a/boards/common/remote/include/periph_common.h +++ b/boards/common/remote/include/periph_common.h @@ -8,7 +8,7 @@ */ /** - * @ingroup boards_remote + * @ingroup boards_common_remote * @{ * * @file From 08e838e9e07f3d3955f2179c79bb6e66e65042e9 Mon Sep 17 00:00:00 2001 From: smlng Date: Thu, 30 Nov 2017 23:37:28 +0100 Subject: [PATCH 11/15] boards/common: enhance doxygen for WSN-430 --- boards/common/wsn430/board_init.c | 12 ++++++++++++ boards/common/wsn430/include/board_common.h | 6 +++--- boards/common/wsn430/include/periph_conf.h | 2 +- 3 files changed, 16 insertions(+), 4 deletions(-) diff --git a/boards/common/wsn430/board_init.c b/boards/common/wsn430/board_init.c index 2eea62e9e5..1792308d73 100644 --- a/boards/common/wsn430/board_init.c +++ b/boards/common/wsn430/board_init.c @@ -7,6 +7,18 @@ * directory for more details. */ + /** + * @ingroup boards_common_wsn430 + * @{ + * + * @file + * @brief Board initialization for WSN430 + * + * @author Milan Babel + * + * @} + */ + #include "cpu.h" #include "irq.h" #include "board.h" diff --git a/boards/common/wsn430/include/board_common.h b/boards/common/wsn430/include/board_common.h index 93cd55c681..cbcef903b7 100644 --- a/boards/common/wsn430/include/board_common.h +++ b/boards/common/wsn430/include/board_common.h @@ -8,9 +8,9 @@ */ /** - * @defgroup boards_wsn430-common WSN430 common - * @ingroup boards - * @brief Common files for WSN430 based boards + * @defgroup boards_common_wsn430 WSN430 common + * @ingroup boards_common + * @brief Shared files and configuration for all WSN430 based boards. * @{ * * @file diff --git a/boards/common/wsn430/include/periph_conf.h b/boards/common/wsn430/include/periph_conf.h index 21fbf7b3e1..e0f32a5e43 100644 --- a/boards/common/wsn430/include/periph_conf.h +++ b/boards/common/wsn430/include/periph_conf.h @@ -8,7 +8,7 @@ */ /** - * @ingroup boards_wsn430-common + * @ingroup boards_common_wsn430 * @{ * * @file From b19422780ca1d7bd8aa4a98c96afe07ca0e3b9a1 Mon Sep 17 00:00:00 2001 From: smlng Date: Thu, 30 Nov 2017 23:37:55 +0100 Subject: [PATCH 12/15] boards/common: enhance doxygen for NXP FRDM --- boards/common/frdm/doc.txt | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 boards/common/frdm/doc.txt diff --git a/boards/common/frdm/doc.txt b/boards/common/frdm/doc.txt new file mode 100644 index 0000000000..c4d79b2245 --- /dev/null +++ b/boards/common/frdm/doc.txt @@ -0,0 +1,13 @@ +/* + * Copyright (C) 2017 HAW Hamburg + * + * This file is subject to the terms and conditions of the GNU Lesser + * General Public License v2.1. See the file LICENSE in the top level + * directory for more details. + */ + +/** + * @defgroup boards_common_frdm NXP FRDM Common + * @ingroup boards_common + * @brief Shared files and configuration for the NXP Freedom Boards. + */ From 7ae468c7f318ed6169ed9b0286edd6748da82de5 Mon Sep 17 00:00:00 2001 From: smlng Date: Thu, 30 Nov 2017 23:39:07 +0100 Subject: [PATCH 13/15] boards/common: enhance doxygen for IoTlab boards --- boards/common/iotlab/include/board_common.h | 6 +++--- boards/common/iotlab/include/gpio_params.h | 2 +- boards/common/iotlab/include/l3g4200d_params.h | 2 +- boards/common/iotlab/include/lsm303dlhc_params.h | 2 +- boards/common/iotlab/include/periph_conf_common.h | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/boards/common/iotlab/include/board_common.h b/boards/common/iotlab/include/board_common.h index 3ff17b1ed6..b029ef1bbc 100644 --- a/boards/common/iotlab/include/board_common.h +++ b/boards/common/iotlab/include/board_common.h @@ -7,9 +7,9 @@ */ /** - * @defgroup boards_iotlab-m3 IoT-LAB M3 open node - * @ingroup boards - * @brief Board specific files for the iotlab-m3 board. + * @defgroup boards_common_iotlab IoTlab Common + * @ingroup boards_common + * @brief Shared files and configuration for the IoTlab boards. * @{ * * @file diff --git a/boards/common/iotlab/include/gpio_params.h b/boards/common/iotlab/include/gpio_params.h index 7a3f26e6c4..8b8a2e065b 100644 --- a/boards/common/iotlab/include/gpio_params.h +++ b/boards/common/iotlab/include/gpio_params.h @@ -7,7 +7,7 @@ */ /** - * @ingroup boards_iotlab-m3 + * @ingroup boards_common_iotlab * @{ * * @file diff --git a/boards/common/iotlab/include/l3g4200d_params.h b/boards/common/iotlab/include/l3g4200d_params.h index 889e770850..239e8ee834 100644 --- a/boards/common/iotlab/include/l3g4200d_params.h +++ b/boards/common/iotlab/include/l3g4200d_params.h @@ -7,7 +7,7 @@ */ /** - * @ingroup boards_iotlab-m3 + * @ingroup boards_common_iotlab * @{ * * @file diff --git a/boards/common/iotlab/include/lsm303dlhc_params.h b/boards/common/iotlab/include/lsm303dlhc_params.h index 2d1dc6cdf6..0f7117d6b9 100644 --- a/boards/common/iotlab/include/lsm303dlhc_params.h +++ b/boards/common/iotlab/include/lsm303dlhc_params.h @@ -7,7 +7,7 @@ */ /** - * @ingroup boards_iotlab-m3 + * @ingroup boards_common_iotlab * @{ * * @file diff --git a/boards/common/iotlab/include/periph_conf_common.h b/boards/common/iotlab/include/periph_conf_common.h index df0ffc6a6f..b69ee112fa 100644 --- a/boards/common/iotlab/include/periph_conf_common.h +++ b/boards/common/iotlab/include/periph_conf_common.h @@ -7,7 +7,7 @@ */ /** - * @ingroup boards_iotlab-m3 + * @ingroup boards_common_iotlab * @{ * * @file From 776a05003bde234ca16a20a518048e990c0579e1 Mon Sep 17 00:00:00 2001 From: smlng Date: Fri, 15 Dec 2017 10:35:48 +0100 Subject: [PATCH 14/15] boards/common: add doxygen group --- boards/common/doc.txt | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 boards/common/doc.txt diff --git a/boards/common/doc.txt b/boards/common/doc.txt new file mode 100644 index 0000000000..8865bf16a9 --- /dev/null +++ b/boards/common/doc.txt @@ -0,0 +1,16 @@ +/* + * Copyright (C) 2017 HAW Hamburg + * + * This file is subject to the terms and conditions of the GNU Lesser + * General Public License v2.1. See the file LICENSE in the top level + * directory for more details. + */ + +/** + * @defgroup boards_common Common Board Groups + * @ingroup boards + * @brief Common definitions and implementations for board groups + * + * Several boards share many definitions and implementations, these are + * collectively stored into a common module per board group. + */ From b1df79a45bb9b6a12966707ef614fa0ddcdb9534 Mon Sep 17 00:00:00 2001 From: smlng Date: Fri, 15 Dec 2017 10:36:09 +0100 Subject: [PATCH 15/15] boards: fix doxygen groups for STM nucleo boards --- boards/common/nucleo/include/board_common.h | 3 +++ boards/common/nucleo144/include/board_common.h | 3 +++ boards/common/nucleo32/include/board_common.h | 3 +++ boards/nucleo144-f207/include/board.h | 2 +- boards/nucleo144-f303/include/board.h | 2 +- boards/nucleo144-f412/include/board.h | 6 +++--- boards/nucleo144-f413/include/board.h | 6 +++--- boards/nucleo144-f429/include/board.h | 2 +- boards/nucleo144-f446/include/board.h | 2 +- boards/nucleo144-f722/include/board.h | 2 +- boards/nucleo144-f746/include/board.h | 2 +- boards/nucleo144-f767/include/board.h | 2 +- boards/nucleo32-f031/include/board.h | 2 +- boards/nucleo32-f042/include/board.h | 6 +++--- boards/nucleo32-f303/include/board.h | 2 +- boards/nucleo32-l031/include/board.h | 2 +- boards/nucleo32-l432/include/board.h | 2 +- 17 files changed, 29 insertions(+), 20 deletions(-) diff --git a/boards/common/nucleo/include/board_common.h b/boards/common/nucleo/include/board_common.h index 7f54386bf1..eb91cd08c2 100644 --- a/boards/common/nucleo/include/board_common.h +++ b/boards/common/nucleo/include/board_common.h @@ -7,6 +7,9 @@ */ /** + * @defgroup boards_nucleo STM Nucleo Boards + * @ingroup boards + * * @defgroup boards_common_nucleo STM Nucleo common * @ingroup boards_common * @brief Shared files and configuration for all STM Nucleo boards. diff --git a/boards/common/nucleo144/include/board_common.h b/boards/common/nucleo144/include/board_common.h index 3a30b92246..e628765b38 100644 --- a/boards/common/nucleo144/include/board_common.h +++ b/boards/common/nucleo144/include/board_common.h @@ -8,6 +8,9 @@ */ /** + * @defgroup boards_nucleo144 STM Nucleo144 Boards + * @ingroup boards + * * @defgroup boards_common_nucleo144 STM Nucleo144 common * @ingroup boards_common * @brief Shared files and configuration for all STM Nucleo144 boards. diff --git a/boards/common/nucleo32/include/board_common.h b/boards/common/nucleo32/include/board_common.h index 7796f904c4..08714fa88c 100644 --- a/boards/common/nucleo32/include/board_common.h +++ b/boards/common/nucleo32/include/board_common.h @@ -7,6 +7,9 @@ */ /** + * @defgroup boards_nucleo32 STM Nucleo32 Boards + * @ingroup boards + * * @defgroup boards_common_nucleo32 STM Nucleo32 common * @ingroup boards_common * @brief Shared files and configuration for all STM Nucleo32 boards. diff --git a/boards/nucleo144-f207/include/board.h b/boards/nucleo144-f207/include/board.h index f1c67df60f..5e0fe0e3ac 100644 --- a/boards/nucleo144-f207/include/board.h +++ b/boards/nucleo144-f207/include/board.h @@ -8,7 +8,7 @@ /** * @defgroup boards_nucleo144-f207 Nucleo144-F207 - * @ingroup boards_nucleo + * @ingroup boards_nucleo144 * @brief Board specific files for the nucleo144-f207 board * @{ * diff --git a/boards/nucleo144-f303/include/board.h b/boards/nucleo144-f303/include/board.h index 5967239f8e..1089d8f2f4 100644 --- a/boards/nucleo144-f303/include/board.h +++ b/boards/nucleo144-f303/include/board.h @@ -8,7 +8,7 @@ /** * @defgroup boards_nucleo144-f303 Nucleo144-F303 - * @ingroup boards_nucleo + * @ingroup boards_nucleo144 * @brief Board specific files for the nucleo144-f303 board * @{ * diff --git a/boards/nucleo144-f412/include/board.h b/boards/nucleo144-f412/include/board.h index 2bc644fc56..4d50cbf563 100644 --- a/boards/nucleo144-f412/include/board.h +++ b/boards/nucleo144-f412/include/board.h @@ -8,9 +8,9 @@ */ /** - * @defgroup boards_nucleo144-f412 Nucleo-F412 - * @ingroup boards_nucleo - * @brief Board specific files for the nucleo144-f412 board + * @defgroup boards_nucleo144-f412 Nucleo144-F412 + * @ingroup boards_nucleo144 + * @brief Board specific files for the STM Nucleo144-f412 board * @{ * * @file diff --git a/boards/nucleo144-f413/include/board.h b/boards/nucleo144-f413/include/board.h index ae09114800..add7de14a4 100644 --- a/boards/nucleo144-f413/include/board.h +++ b/boards/nucleo144-f413/include/board.h @@ -8,9 +8,9 @@ */ /** - * @defgroup boards_nucleo144-f413 Nucleo-F413 - * @ingroup boards_nucleo - * @brief Board specific files for the nucleo144-f413 board + * @defgroup boards_nucleo144-f413 Nucleo144-F413 + * @ingroup boards_nucleo144 + * @brief Board specific files for the STM Nucleo144-f413 board * @{ * * @file diff --git a/boards/nucleo144-f429/include/board.h b/boards/nucleo144-f429/include/board.h index 4e48d1eecc..6d1883a150 100644 --- a/boards/nucleo144-f429/include/board.h +++ b/boards/nucleo144-f429/include/board.h @@ -8,7 +8,7 @@ /** * @defgroup boards_nucleo144-f429 Nucleo144-F429 - * @ingroup boards_nucleo + * @ingroup boards_nucleo144 * @brief Board specific files for the nucleo144-f429 board * @{ * diff --git a/boards/nucleo144-f446/include/board.h b/boards/nucleo144-f446/include/board.h index 507f214c87..c1b7e624b2 100644 --- a/boards/nucleo144-f446/include/board.h +++ b/boards/nucleo144-f446/include/board.h @@ -8,7 +8,7 @@ /** * @defgroup boards_nucleo144-f446 Nucleo144-F446 - * @ingroup boards_nucleo + * @ingroup boards_nucleo144 * @brief Board specific files for the nucleo144-f446 board * @{ * diff --git a/boards/nucleo144-f722/include/board.h b/boards/nucleo144-f722/include/board.h index a87d63c4e8..03ac89c837 100644 --- a/boards/nucleo144-f722/include/board.h +++ b/boards/nucleo144-f722/include/board.h @@ -8,7 +8,7 @@ /** * @defgroup boards_nucleo144-f722 Nucleo144-F722 - * @ingroup boards + * @ingroup boards_nucleo144 * @brief Board specific files for the nucleo144-f722 board * @{ * diff --git a/boards/nucleo144-f746/include/board.h b/boards/nucleo144-f746/include/board.h index 4de9f3e647..1072145e0b 100644 --- a/boards/nucleo144-f746/include/board.h +++ b/boards/nucleo144-f746/include/board.h @@ -8,7 +8,7 @@ /** * @defgroup boards_nucleo144-f746 Nucleo144-F746 - * @ingroup boards_nucleo + * @ingroup boards_nucleo144 * @brief Board specific files for the nucleo144-f746 board * @{ * diff --git a/boards/nucleo144-f767/include/board.h b/boards/nucleo144-f767/include/board.h index 5b7ed437a3..afc818a646 100644 --- a/boards/nucleo144-f767/include/board.h +++ b/boards/nucleo144-f767/include/board.h @@ -8,7 +8,7 @@ /** * @defgroup boards_nucleo144-f767 Nucleo144-F767 - * @ingroup boards_nucleo + * @ingroup boards_nucleo144 * @brief Board specific files for the nucleo144-f767 board * @{ * diff --git a/boards/nucleo32-f031/include/board.h b/boards/nucleo32-f031/include/board.h index 9549895512..024ec522e4 100644 --- a/boards/nucleo32-f031/include/board.h +++ b/boards/nucleo32-f031/include/board.h @@ -9,7 +9,7 @@ /** * @defgroup boards_nucleo32-f031 Nucleo32-F031 - * @ingroup boards_nucleo + * @ingroup boards_nucleo32 * @brief Board specific files for the nucleo32-f031 board * @{ * diff --git a/boards/nucleo32-f042/include/board.h b/boards/nucleo32-f042/include/board.h index 6f2955c041..68240a0cc3 100644 --- a/boards/nucleo32-f042/include/board.h +++ b/boards/nucleo32-f042/include/board.h @@ -7,9 +7,9 @@ */ /** - * @defgroup boards_nucleo32-f042 Nucleo-F042 - * @ingroup boards_nucleo - * @brief Board specific files for the nucleo32-f042 board + * @defgroup boards_nucleo32-f042 Nucleo32-F042 + * @ingroup boards_nucleo32 + * @brief Board specific files for the STM Nucleo32-f042 board * @{ * * @file diff --git a/boards/nucleo32-f303/include/board.h b/boards/nucleo32-f303/include/board.h index 090b7a940e..2a904cfcfd 100644 --- a/boards/nucleo32-f303/include/board.h +++ b/boards/nucleo32-f303/include/board.h @@ -8,7 +8,7 @@ /** * @defgroup boards_nucleo32-f303 Nucleo32-F303 - * @ingroup boards_nucleo + * @ingroup boards_nucleo32 * @brief Board specific files for the nucleo32-f303 board * @{ * diff --git a/boards/nucleo32-l031/include/board.h b/boards/nucleo32-l031/include/board.h index 6d764134f5..c0ea3ff775 100644 --- a/boards/nucleo32-l031/include/board.h +++ b/boards/nucleo32-l031/include/board.h @@ -9,7 +9,7 @@ /** * @defgroup boards_nucleo32-l031 Nucleo32-L031 - * @ingroup boards_nucleo + * @ingroup boards_nucleo32 * @brief Board specific files for the nucleo32-l031 board * @{ * diff --git a/boards/nucleo32-l432/include/board.h b/boards/nucleo32-l432/include/board.h index 6b9a8af095..66ec34b661 100644 --- a/boards/nucleo32-l432/include/board.h +++ b/boards/nucleo32-l432/include/board.h @@ -9,7 +9,7 @@ /** * @defgroup boards_nucleo32-l432 Nucleo32-L432 - * @ingroup boards_nucleo + * @ingroup boards_nucleo32 * @brief Board specific files for the nucleo32-l432 board * @{ *