From 9904f9803e3e0d36fc4a3aa6d75038df1535c3d9 Mon Sep 17 00:00:00 2001 From: Karl Palsson Date: Mon, 10 Jun 2019 11:20:57 +0000 Subject: [PATCH] doc: stm32: unify "peripheral API" titles doxygen really wants the @defgroup _and_ the @addtogroup to both have the full name, matching identically, to avoid all warnings. Standardize on the "CAPS_PERIPH peripheral API" style. --- lib/stm32/common/timer_common_all.c | 2 +- lib/stm32/f0/flash.c | 2 +- lib/stm32/f0/rcc.c | 2 +- lib/stm32/f1/flash.c | 2 +- lib/stm32/f1/rcc.c | 2 +- lib/stm32/f1/timer.c | 2 +- lib/stm32/f2/flash.c | 2 +- lib/stm32/f2/rcc.c | 2 +- lib/stm32/f3/flash.c | 2 +- lib/stm32/f3/rcc.c | 2 +- lib/stm32/f4/flash.c | 2 +- lib/stm32/f4/pwr.c | 2 +- lib/stm32/f4/rcc.c | 2 +- lib/stm32/f4/rtc.c | 2 +- lib/stm32/f7/flash.c | 2 +- lib/stm32/f7/rcc.c | 2 +- lib/stm32/g0/flash.c | 2 +- lib/stm32/l1/flash.c | 2 +- lib/stm32/l1/rcc.c | 2 +- lib/stm32/l1/timer.c | 2 +- lib/stm32/l4/flash.c | 2 +- 21 files changed, 21 insertions(+), 21 deletions(-) diff --git a/lib/stm32/common/timer_common_all.c b/lib/stm32/common/timer_common_all.c index b9512f5b..64701836 100644 --- a/lib/stm32/common/timer_common_all.c +++ b/lib/stm32/common/timer_common_all.c @@ -1,4 +1,4 @@ -/** @addtogroup timer_file Timer peripheral API +/** @addtogroup timer_file TIMER peripheral API @ingroup peripheral_apis @author @htmlonly © @endhtmlonly 2010 diff --git a/lib/stm32/f0/flash.c b/lib/stm32/f0/flash.c index 9e7ebc33..d594a5e6 100644 --- a/lib/stm32/f0/flash.c +++ b/lib/stm32/f0/flash.c @@ -1,4 +1,4 @@ -/** @defgroup flash_file +/** @defgroup flash_file FLASH peripheral API * * @ingroup peripheral_apis * diff --git a/lib/stm32/f0/rcc.c b/lib/stm32/f0/rcc.c index a0e859b5..cc52fad3 100644 --- a/lib/stm32/f0/rcc.c +++ b/lib/stm32/f0/rcc.c @@ -1,4 +1,4 @@ -/** @defgroup rcc_file RCC Peripheral API +/** @defgroup rcc_file RCC peripheral API * * @ingroup peripheral_apis * diff --git a/lib/stm32/f1/flash.c b/lib/stm32/f1/flash.c index 8c8c6e5f..c990b1e6 100644 --- a/lib/stm32/f1/flash.c +++ b/lib/stm32/f1/flash.c @@ -1,4 +1,4 @@ -/** @defgroup flash_file +/** @defgroup flash_file FLASH peripheral API * * @ingroup peripheral_apis * diff --git a/lib/stm32/f1/rcc.c b/lib/stm32/f1/rcc.c index f09fbc0f..9d01881a 100644 --- a/lib/stm32/f1/rcc.c +++ b/lib/stm32/f1/rcc.c @@ -1,4 +1,4 @@ -/** @defgroup rcc_file RCC Peripheral API +/** @defgroup rcc_file RCC peripheral API @ingroup peripheral_apis diff --git a/lib/stm32/f1/timer.c b/lib/stm32/f1/timer.c index b04bd971..6640d6f3 100644 --- a/lib/stm32/f1/timer.c +++ b/lib/stm32/f1/timer.c @@ -1,4 +1,4 @@ -/** @defgroup timer_file +/** @defgroup timer_file TIMER peripheral API @ingroup peripheral_apis @brief libopencm3 STM32F1xx Timers diff --git a/lib/stm32/f2/flash.c b/lib/stm32/f2/flash.c index 0744ba5b..958e62a9 100644 --- a/lib/stm32/f2/flash.c +++ b/lib/stm32/f2/flash.c @@ -1,4 +1,4 @@ -/** @defgroup flash_file +/** @defgroup flash_file FLASH peripheral API * * @ingroup peripheral_apis * diff --git a/lib/stm32/f2/rcc.c b/lib/stm32/f2/rcc.c index 3b3c73f6..e530de47 100644 --- a/lib/stm32/f2/rcc.c +++ b/lib/stm32/f2/rcc.c @@ -1,4 +1,4 @@ -/** @defgroup rcc_file RCC Peripheral API +/** @defgroup rcc_file RCC peripheral API * * @ingroup peripheral_apis * diff --git a/lib/stm32/f3/flash.c b/lib/stm32/f3/flash.c index e987d374..7d73ce62 100644 --- a/lib/stm32/f3/flash.c +++ b/lib/stm32/f3/flash.c @@ -1,4 +1,4 @@ -/** @defgroup flash_file +/** @defgroup flash_file FLASH peripheral API * * @ingroup peripheral_apis * diff --git a/lib/stm32/f3/rcc.c b/lib/stm32/f3/rcc.c index 2a3d2150..3e1852bf 100644 --- a/lib/stm32/f3/rcc.c +++ b/lib/stm32/f3/rcc.c @@ -1,4 +1,4 @@ -/** @defgroup rcc_file RCC Peripheral API +/** @defgroup rcc_file RCC peripheral API * * @ingroup peripheral_apis * diff --git a/lib/stm32/f4/flash.c b/lib/stm32/f4/flash.c index 75407d0d..93cef9f3 100644 --- a/lib/stm32/f4/flash.c +++ b/lib/stm32/f4/flash.c @@ -1,4 +1,4 @@ -/** @defgroup flash_file +/** @defgroup flash_file FLASH peripheral API * * @ingroup peripheral_apis * diff --git a/lib/stm32/f4/pwr.c b/lib/stm32/f4/pwr.c index 9bd2f8da..0d0c2d2d 100644 --- a/lib/stm32/f4/pwr.c +++ b/lib/stm32/f4/pwr.c @@ -1,4 +1,4 @@ -/** @defgroup pwr_file +/** @defgroup pwr_file PWR peripheral API * * @ingroup peripheral_apis * diff --git a/lib/stm32/f4/rcc.c b/lib/stm32/f4/rcc.c index 74778410..66c3d4a1 100644 --- a/lib/stm32/f4/rcc.c +++ b/lib/stm32/f4/rcc.c @@ -1,4 +1,4 @@ -/** @defgroup rcc_file RCC Peripheral API +/** @defgroup rcc_file RCC peripheral API * * @ingroup peripheral_apis * diff --git a/lib/stm32/f4/rtc.c b/lib/stm32/f4/rtc.c index 4d1008c1..847fb55b 100644 --- a/lib/stm32/f4/rtc.c +++ b/lib/stm32/f4/rtc.c @@ -1,4 +1,4 @@ -/** @defgroup rtc_file +/** @defgroup rtc_file RTC peripheral API * * @ingroup peripheral_apis * diff --git a/lib/stm32/f7/flash.c b/lib/stm32/f7/flash.c index 341a32f2..82dcf4f3 100644 --- a/lib/stm32/f7/flash.c +++ b/lib/stm32/f7/flash.c @@ -1,4 +1,4 @@ -/** @defgroup flash_file +/** @defgroup flash_file FLASH peripheral API * * @ingroup peripheral_apis */ diff --git a/lib/stm32/f7/rcc.c b/lib/stm32/f7/rcc.c index 64b27427..7abdd770 100644 --- a/lib/stm32/f7/rcc.c +++ b/lib/stm32/f7/rcc.c @@ -1,4 +1,4 @@ -/** @defgroup rcc_file RCC Peripheral API +/** @defgroup rcc_file RCC peripheral API * * @ingroup peripheral_apis * This library supports the Reset and Clock Control System in the STM32 series diff --git a/lib/stm32/g0/flash.c b/lib/stm32/g0/flash.c index bb19d598..74ecf5d0 100644 --- a/lib/stm32/g0/flash.c +++ b/lib/stm32/g0/flash.c @@ -1,4 +1,4 @@ -/** @defgroup flash_file +/** @defgroup flash_file FLASH peripheral API * * @ingroup peripheral_apis * diff --git a/lib/stm32/l1/flash.c b/lib/stm32/l1/flash.c index 416b4efc..dfd90d25 100644 --- a/lib/stm32/l1/flash.c +++ b/lib/stm32/l1/flash.c @@ -1,4 +1,4 @@ -/** @defgroup flash_file +/** @defgroup flash_file FLASH peripheral API * * @ingroup peripheral_apis * diff --git a/lib/stm32/l1/rcc.c b/lib/stm32/l1/rcc.c index 6d4ddfa7..44eac07b 100644 --- a/lib/stm32/l1/rcc.c +++ b/lib/stm32/l1/rcc.c @@ -1,4 +1,4 @@ -/** @defgroup rcc_file RCC Peripheral API +/** @defgroup rcc_file RCC peripheral API @ingroup peripheral_apis diff --git a/lib/stm32/l1/timer.c b/lib/stm32/l1/timer.c index f9ce5dd0..fa701dd1 100644 --- a/lib/stm32/l1/timer.c +++ b/lib/stm32/l1/timer.c @@ -1,4 +1,4 @@ -/** @defgroup timer_file +/** @defgroup timer_file TIMER peripheral API @ingroup peripheral_apis @brief libopencm3 STM32L1xx Timers diff --git a/lib/stm32/l4/flash.c b/lib/stm32/l4/flash.c index 2aff56a6..16007ee6 100644 --- a/lib/stm32/l4/flash.c +++ b/lib/stm32/l4/flash.c @@ -1,4 +1,4 @@ -/** @defgroup flash_file +/** @defgroup flash_file FLASH peripheral API * * @ingroup peripheral_apis *