riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

cpu/stm32: adapt Doxygen documentation

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cpu/stm32/cpu_common.c
View File

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

2
cpu/stm32/cpu_init.c
View File

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

12
cpu/stm32/doc.txt
View File

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

2
cpu/stm32/include/candev_stm32.h
View File

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

4
cpu/stm32/include/cpu_conf.h
View File

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

2
cpu/stm32/include/cpu_conf_stm32_common.h
View File

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

4
cpu/stm32/include/periph/f0/periph_cpu.h
View File

@ -7,11 +7,11 @@
*/
/**
* @ingroup cpu_stm32f0
* @ingroup cpu_stm32
* @{
*
* @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>
*/

4
cpu/stm32/include/periph/f1/periph_cpu.h
View File

@ -7,11 +7,11 @@
*/
/**
* @ingroup cpu_stm32f1
* @ingroup cpu_stm32
* @{
*
* @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>
*/

4
cpu/stm32/include/periph/f2/periph_cpu.h
View File

@ -8,11 +8,11 @@
*/
/**
* @ingroup cpu_stm32f2
* @ingroup cpu_stm32
* @{
*
* @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 Aurelien Gonce <aurelien.gonce@altran.fr>

4
cpu/stm32/include/periph/f3/periph_cpu.h
View File

@ -7,11 +7,11 @@
*/
/**
* @ingroup cpu_stm32f3
* @ingroup cpu_stm32
* @{
*
* @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>
*/

4
cpu/stm32/include/periph/f4/periph_cpu.h
View File

@ -7,11 +7,11 @@
*/
/**
* @ingroup cpu_stm32f4
* @ingroup cpu_stm32
* @{
*
* @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>
*/

4
cpu/stm32/include/periph/f7/periph_cpu.h
View File

@ -7,11 +7,11 @@
*/
/**
* @ingroup cpu_stm32f7
* @ingroup cpu_stm32
* @{
*
* @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>
*

4
cpu/stm32/include/periph/l0/periph_cpu.h
View File

@ -8,11 +8,11 @@
*/
/**
* @ingroup cpu_stm32l0
* @ingroup cpu_stm32
* @{
*
* @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 Alexandre Abadie <alexandre.abadie@inria.fr>

4
cpu/stm32/include/periph/l1/periph_cpu.h
View File

@ -8,11 +8,11 @@
*/
/**
* @ingroup cpu_stm32l1
* @ingroup cpu_stm32
* @{
*
* @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 Katja Kirstein <katja.kirstein@haw-hamburg.de>

4
cpu/stm32/include/periph/l4/periph_cpu.h
View File

@ -7,11 +7,11 @@
*/
/**
* @ingroup cpu_stm32l4
* @ingroup cpu_stm32
* @{
*
* @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>
*

4
cpu/stm32/include/periph/wb/periph_cpu.h
View File

@ -7,11 +7,11 @@
*/
/**
* @ingroup cpu_stm32wb
* @ingroup cpu_stm32
* @{
*
* @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>
*

2
cpu/stm32/include/periph_cpu.h
View File

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

2
cpu/stm32/include/stmclk.h
View File

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

4
cpu/stm32/include/usbdev_stm32.h
View File

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

2
cpu/stm32/periph/adc_f0.c
View File

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

2
cpu/stm32/periph/adc_f1.c
View File

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

2
cpu/stm32/periph/adc_f2.c
View File

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

2
cpu/stm32/periph/adc_f4.c
View File

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

2
cpu/stm32/periph/adc_l0.c
View File

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

2
cpu/stm32/periph/adc_l1.c
View File

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

2
cpu/stm32/periph/adc_l4.c
View File

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

2
cpu/stm32/periph/can.c
View File

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

2
cpu/stm32/periph/dac.c
View File

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

2
cpu/stm32/periph/dma.c
View File

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

2
cpu/stm32/periph/eeprom.c
View File

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

2
cpu/stm32/periph/eth.c
View File

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

2
cpu/stm32/periph/flash_common.c
View File

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

2
cpu/stm32/periph/flashpage.c
View File

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

2
cpu/stm32/periph/gpio_all.c
View File

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

4
cpu/stm32/periph/gpio_f1.c
View File

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

2
cpu/stm32/periph/hwrng.c
View File

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

2
cpu/stm32/periph/i2c_1.c
View File

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

2
cpu/stm32/periph/i2c_2.c
View File

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

2
cpu/stm32/periph/pm.c
View File

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

2
cpu/stm32/periph/pwm.c
View File

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

2
cpu/stm32/periph/rtc_all.c
View File

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

4
cpu/stm32/periph/rtc_f1.c
View File

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

2
cpu/stm32/periph/rtt_all.c
View File

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

4
cpu/stm32/periph/rtt_f1.c
View File

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

2
cpu/stm32/periph/spi.c
View File

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

2
cpu/stm32/periph/timer.c
View File

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

2
cpu/stm32/periph/uart.c
View File

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

2
cpu/stm32/periph/usbdev.c
View File

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

2
cpu/stm32/periph/wdt.c
View File

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

2
cpu/stm32/stmclk.c
View File

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

2
cpu/stm32/stmclk_common.c
View File

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

2
cpu/stm32/stmclk_l0l1.c
View File

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

2
cpu/stm32/stmclk_l4wb.c
View File

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

4
cpu/stm32/vectors/vectors_f0.c
View File

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

4
cpu/stm32/vectors/vectors_f1.c
View File

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

4
cpu/stm32/vectors/vectors_f2.c
View File

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

4
cpu/stm32/vectors/vectors_f3.c
View File

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

4
cpu/stm32/vectors/vectors_f4.c
View File

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

4
cpu/stm32/vectors/vectors_f7.c
View File

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

4
cpu/stm32/vectors/vectors_l0.c
View File

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

4
cpu/stm32/vectors/vectors_l1.c
View File

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

4
cpu/stm32/vectors/vectors_l4.c
View File

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

4
cpu/stm32/vectors/vectors_wb.c
View File

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