cpu/stm32: adapt Doxygen documentation

This commit is contained in:
Alexandre Abadie 2020-05-03 17:17:54 +02:00
parent c50afaaf1b
commit b6d2231d6d
No known key found for this signature in database
GPG Key ID: 1C919A403CAE1405
63 changed files with 91 additions and 95 deletions

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_cortexm_common * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file

View File

@ -12,7 +12,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file

View File

@ -1,15 +1,13 @@
/** /**
* @defgroup cpu_stm32_common STM32 common * @defgroup cpu_stm32 STM32
* @ingroup cpu * @ingroup cpu
* @brief STM32 common code and definitions * @brief All STM32 families code and definitions
* *
* This module contains all common code and definition to all STM32 cpu * This module contains all code and definition to all STM32 cpu
* families supported by RIOT: @ref cpu_stm32f0, @ref cpu_stm32l0, * families supported by RIOT: F0, F1, F2, F3, F4, F7, L0, L4 and WB.
* @ref cpu_stm32f1, @ref cpu_stm32f2, @ref cpu_stm32f3, @ref cpu_stm32f4,
* @ref cpu_stm32l4, @ref cpu_stm32f7.
* *
* STM32Fx Clock configuration * STM32Fx Clock configuration
* ================================= * ===========================
* *
* stm32fx cpus share clock configuration code and macro. * stm32fx cpus share clock configuration code and macro.
* It can be configured as described here. * It can be configured as described here.

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @ingroup drivers_can * @ingroup drivers_can
* @defgroup candev_stm32 STM32 CAN controller * @defgroup candev_stm32 STM32 CAN controller
* @brief STM32 CAN controller driver (bxCAN) * @brief STM32 CAN controller driver (bxCAN)

View File

@ -8,9 +8,7 @@
*/ */
/** /**
* @defgroup cpu_stm32f0 STM32F0 * @ingroup cpu_stm32
* @brief STM32F0 specific code
* @ingroup cpu
* @{ * @{
* *
* @file * @file

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file

View File

@ -7,11 +7,11 @@
*/ */
/** /**
* @ingroup cpu_stm32f0 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief CPU specific definitions for internal peripheral handling * @brief STM32F0 CPU specific definitions for internal peripheral handling
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/ */

View File

@ -7,11 +7,11 @@
*/ */
/** /**
* @ingroup cpu_stm32f1 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief CPU specific definitions for internal peripheral handling * @brief STM32F1 CPU specific definitions for internal peripheral handling
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/ */

View File

@ -8,11 +8,11 @@
*/ */
/** /**
* @ingroup cpu_stm32f2 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief CPU specific definitions for internal peripheral handling * @brief STM32F2 CPU specific definitions for internal peripheral handling
* *
* @author Nick v. IJzendoorn <nijzendoorn@engineering-spirit.nl> * @author Nick v. IJzendoorn <nijzendoorn@engineering-spirit.nl>
* @author Aurelien Gonce <aurelien.gonce@altran.fr> * @author Aurelien Gonce <aurelien.gonce@altran.fr>

View File

@ -7,11 +7,11 @@
*/ */
/** /**
* @ingroup cpu_stm32f3 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief CPU specific definitions for internal peripheral handling * @brief STM32F3 CPU specific definitions for internal peripheral handling
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/ */

View File

@ -7,11 +7,11 @@
*/ */
/** /**
* @ingroup cpu_stm32f4 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief CPU specific definitions for internal peripheral handling * @brief STM32F4 CPU specific definitions for internal peripheral handling
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/ */

View File

@ -7,11 +7,11 @@
*/ */
/** /**
* @ingroup cpu_stm32f7 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief CPU specific definitions for internal peripheral handling * @brief STM32F7 CPU specific definitions for internal peripheral handling
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* *

View File

@ -8,11 +8,11 @@
*/ */
/** /**
* @ingroup cpu_stm32l0 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief CPU specific definitions for internal peripheral handling * @brief STM32L0 CPU specific definitions for internal peripheral handling
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* @author Alexandre Abadie <alexandre.abadie@inria.fr> * @author Alexandre Abadie <alexandre.abadie@inria.fr>

View File

@ -8,11 +8,11 @@
*/ */
/** /**
* @ingroup cpu_stm32l1 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief CPU specific definitions for internal peripheral handling * @brief STM32L1 CPU specific definitions for internal peripheral handling
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* @author Katja Kirstein <katja.kirstein@haw-hamburg.de> * @author Katja Kirstein <katja.kirstein@haw-hamburg.de>

View File

@ -7,11 +7,11 @@
*/ */
/** /**
* @ingroup cpu_stm32l4 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief CPU specific definitions for internal peripheral handling * @brief STM32L4 CPU specific definitions for internal peripheral handling
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* *

View File

@ -7,11 +7,11 @@
*/ */
/** /**
* @ingroup cpu_stm32wb * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief CPU specific definitions for internal peripheral handling * @brief STM32WB CPU specific definitions for internal peripheral handling
* *
* @author Francisco Molina <francois-xavier.molina@inria.fr> * @author Francisco Molina <francois-xavier.molina@inria.fr>
* *

View File

@ -8,7 +8,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file

View File

@ -7,8 +7,8 @@
*/ */
/** /**
* @defgroup cpu_stm32_common_usbdev stm32 USB OTG FS/HS peripheral * @defgroup cpu_stm32_usbdev stm32 USB OTG FS/HS peripheral
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @brief USB interface functions for the stm32 class devices * @brief USB interface functions for the stm32 class devices
* *
* @{ * @{

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_stm32f0 * @ingroup cpu_stm32
* @ingroup drivers_periph_adc * @ingroup drivers_periph_adc
* @{ * @{
* *

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_stm32f1 * @ingroup cpu_stm32
* @ingroup drivers_periph_adc * @ingroup drivers_periph_adc
* @{ * @{
* *

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_stm32f2 * @ingroup cpu_stm32
* @ingroup drivers_periph_adc * @ingroup drivers_periph_adc
* @{ * @{
* *

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_stm32f4 * @ingroup cpu_stm32
* @ingroup drivers_periph_adc * @ingroup drivers_periph_adc
* @{ * @{
* *

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_stm32l0 * @ingroup cpu_stm32
* @ingroup drivers_periph_adc * @ingroup drivers_periph_adc
* @{ * @{
* *

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_stm32l1 * @ingroup cpu_stm32
* @ingroup drivers_periph_adc * @ingroup drivers_periph_adc
* @{ * @{
* *

View File

@ -8,7 +8,7 @@
*/ */
/** /**
* @ingroup cpu_stm32l4 * @ingroup cpu_stm32
* @ingroup drivers_periph_adc * @ingroup drivers_periph_adc
* @{ * @{
* *

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file

View File

@ -8,7 +8,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @ingroup drivers_periph_dac * @ingroup drivers_periph_dac
* @{ * @{
* *

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @ingroup drivers_periph_eeprom * @ingroup drivers_periph_eeprom
* @{ * @{
* *

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file

View File

@ -8,7 +8,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @ingroup drivers_periph_flashpage * @ingroup drivers_periph_flashpage
* @{ * @{
* *

View File

@ -10,7 +10,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @ingroup drivers_periph_gpio * @ingroup drivers_periph_gpio
* @{ * @{
* *

View File

@ -7,12 +7,12 @@
*/ */
/** /**
* @ingroup cpu_stm32f1 * @ingroup cpu_stm32
* @ingroup drivers_periph_gpio * @ingroup drivers_periph_gpio
* @{ * @{
* *
* @file * @file
* @brief Low-level GPIO driver implementation * @brief Low-level GPIO driver implementation for STM32F1
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* @author Thomas Eichinger <thomas.eichinger@fu-berlin.de> * @author Thomas Eichinger <thomas.eichinger@fu-berlin.de>

View File

@ -8,7 +8,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @ingroup drivers_periph_hwrng * @ingroup drivers_periph_hwrng
* @{ * @{
* *

View File

@ -10,7 +10,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @ingroup drivers_periph_i2c * @ingroup drivers_periph_i2c
* @{ * @{
* *

View File

@ -10,7 +10,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @ingroup drivers_periph_i2c * @ingroup drivers_periph_i2c
* @{ * @{
* *

View File

@ -11,7 +11,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @ingroup drivers_periph_pm * @ingroup drivers_periph_pm
* @{ * @{
* *

View File

@ -9,7 +9,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @ingroup drivers_periph_pwm * @ingroup drivers_periph_pwm
* @{ * @{
* *

View File

@ -10,7 +10,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @{ * @{
* @file * @file
* @brief Low-level RTC driver implementation * @brief Low-level RTC driver implementation

View File

@ -7,10 +7,10 @@
*/ */
/** /**
* @ingroup cpu_stm32f1 * @ingroup cpu_stm32
* @{ * @{
* @file * @file
* @brief Low-level RTC driver implementation * @brief Low-level RTC driver implementation for STM32F1
* *
* @author Alexei Bezborodov <alexeibv+riotos@narod.ru> * @author Alexei Bezborodov <alexeibv+riotos@narod.ru>
* @} * @}

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @ingroup drivers_periph_rtt * @ingroup drivers_periph_rtt
* @{ * @{
* *

View File

@ -7,12 +7,12 @@
*/ */
/** /**
* @ingroup cpu_stm32f1 * @ingroup cpu_stm32
* @ingroup drivers_periph_rtt * @ingroup drivers_periph_rtt
* @{ * @{
* *
* @file * @file
* @brief Low-level RTT driver implementation * @brief Low-level RTT driver implementation for STM32F1
* *
* @author Thomas Eichinger <thomas.eichinger@fu-berlin.de> * @author Thomas Eichinger <thomas.eichinger@fu-berlin.de>
* *

View File

@ -9,7 +9,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @ingroup drivers_periph_spi * @ingroup drivers_periph_spi
* @{ * @{
* *

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @ingroup drivers_periph_timer * @ingroup drivers_periph_timer
* @{ * @{
* *

View File

@ -9,7 +9,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @ingroup drivers_periph_uart * @ingroup drivers_periph_uart
* @{ * @{
* *

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common_usbdev * @ingroup cpu_stm32_usbdev
* @{ * @{
* @file * @file
* @brief Low level USB interface functions for the stm32 FS/HS devices * @brief Low level USB interface functions for the stm32 FS/HS devices

View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @ingroup drivers_periph_wdt * @ingroup drivers_periph_wdt
* *
* @brief * @brief

View File

@ -8,7 +8,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file

View File

@ -8,7 +8,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file

View File

@ -9,7 +9,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file

View File

@ -9,7 +9,7 @@
*/ */
/** /**
* @ingroup cpu_stm32_common * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file

View File

@ -7,11 +7,11 @@
*/ */
/** /**
* @ingroup cpu_stm32f0 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief Interrupt vector definitions * @brief Interrupt vector definitions for STM32F0
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* *

View File

@ -7,11 +7,11 @@
*/ */
/** /**
* @ingroup cpu_stm32f1 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief Interrupt vector definitions * @brief Interrupt vector definitions for STM32F1
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* @author Thomas Eichinger <thomas.eichinger@fu-berlin.de> * @author Thomas Eichinger <thomas.eichinger@fu-berlin.de>

View File

@ -8,11 +8,11 @@
*/ */
/** /**
* @ingroup cpu_stm32f2 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief Interrupt vector definitions * @brief Interrupt vector definitions for STM32F2
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* @author Nick v. IJzendoorn <nijzendoorn@engineering-spirit.nl> * @author Nick v. IJzendoorn <nijzendoorn@engineering-spirit.nl>

View File

@ -7,11 +7,11 @@
*/ */
/** /**
* @ingroup cpu_stm32f3 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief Interrupt vector definitions * @brief Interrupt vector definitions for STM32F3
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* *

View File

@ -8,11 +8,11 @@
*/ */
/** /**
* @ingroup cpu_stm32f4 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief Interrupt vector definitions * @brief Interrupt vector definitions for STM32F4
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* @author Vincent Dupont <vincent@otakeys.com> * @author Vincent Dupont <vincent@otakeys.com>

View File

@ -7,11 +7,11 @@
*/ */
/** /**
* @ingroup cpu_stm32f7 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief Interrupt vector definitions * @brief Interrupt vector definitions for STM32F7
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* *

View File

@ -8,11 +8,11 @@
*/ */
/** /**
* @ingroup cpu_stm32l0 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief Interrupt vector definitions * @brief Interrupt vector definitions for STM32L0
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* @author Alexandre Abadie <alexandre.abadie@inria.fr> * @author Alexandre Abadie <alexandre.abadie@inria.fr>

View File

@ -7,11 +7,11 @@
*/ */
/** /**
* @ingroup cpu_stm32l1 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief Interrupt vector definitions * @brief Interrupt vector definitions for STM32L1
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* @author Thomas Eichinger <thomas.eichinger@fu-berlin.de> * @author Thomas Eichinger <thomas.eichinger@fu-berlin.de>

View File

@ -7,11 +7,11 @@
*/ */
/** /**
* @ingroup cpu_stm32l4 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief Interrupt vector definitions * @brief Interrupt vector definitions for STM32L4
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* *

View File

@ -7,11 +7,11 @@
*/ */
/** /**
* @ingroup cpu_stm32l4 * @ingroup cpu_stm32
* @{ * @{
* *
* @file * @file
* @brief Interrupt vector definitions * @brief Interrupt vector definitions for STM32WB
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* *