Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/thirdpin/libopencm3.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl Palsson <karlp@etactica.com>2019-06-10 15:53:14 +0300
committerKarl Palsson <karlp@tweak.net.au>2019-06-13 00:56:09 +0300
commitc9d45e0e2c47c68bf52a44af3dff8488c7b057f6 (patch)
tree174a7c956355f939299b03c0483b2a5f3a81df13
parentb4b2a2101cc7f252c0ffab92cffc1aebf68a8108 (diff)
doc: stm32: move RCC to peripheral api style
For f7, it was completely missing doc markers
-rw-r--r--lib/stm32/common/rcc_common_all.c3
-rw-r--r--lib/stm32/f0/rcc.c4
-rw-r--r--lib/stm32/f1/rcc.c4
-rw-r--r--lib/stm32/f2/rcc.c4
-rw-r--r--lib/stm32/f3/rcc.c4
-rw-r--r--lib/stm32/f4/rcc.c4
-rw-r--r--lib/stm32/f7/rcc.c13
-rw-r--r--lib/stm32/l0/rcc.c4
-rw-r--r--lib/stm32/l1/rcc.c4
-rw-r--r--lib/stm32/l4/rcc.c4
10 files changed, 32 insertions, 16 deletions
diff --git a/lib/stm32/common/rcc_common_all.c b/lib/stm32/common/rcc_common_all.c
index e338dcea..5852b675 100644
--- a/lib/stm32/common/rcc_common_all.c
+++ b/lib/stm32/common/rcc_common_all.c
@@ -1,3 +1,6 @@
+/** @addtogroup rcc_file RCC peripheral API
+ * @ingroup peripheral_apis
+ */
/*
* This file is part of the libopencm3 project.
*
diff --git a/lib/stm32/f0/rcc.c b/lib/stm32/f0/rcc.c
index d4b79e5d..e0758c0a 100644
--- a/lib/stm32/f0/rcc.c
+++ b/lib/stm32/f0/rcc.c
@@ -1,6 +1,6 @@
-/** @defgroup STM32F0xx-rcc-file RCC
+/** @defgroup rcc_file RCC Peripheral API
*
- * @ingroup STM32F0xx
+ * @ingroup peripheral_apis
*
* @brief <b>libopencm3 STM32F0xx Reset and Clock Control</b>
*
diff --git a/lib/stm32/f1/rcc.c b/lib/stm32/f1/rcc.c
index 69041d7c..f09fbc0f 100644
--- a/lib/stm32/f1/rcc.c
+++ b/lib/stm32/f1/rcc.c
@@ -1,6 +1,6 @@
-/** @defgroup STM32F1xx-rcc-file RCC
+/** @defgroup rcc_file RCC Peripheral API
-@ingroup STM32F1xx
+@ingroup peripheral_apis
@brief <b>libopencm3 STM32F1xx Reset and Clock Control</b>
diff --git a/lib/stm32/f2/rcc.c b/lib/stm32/f2/rcc.c
index d01dbcc0..3b3c73f6 100644
--- a/lib/stm32/f2/rcc.c
+++ b/lib/stm32/f2/rcc.c
@@ -1,6 +1,6 @@
-/** @defgroup rcc_file RCC
+/** @defgroup rcc_file RCC Peripheral API
*
- * @ingroup STM32F2xx
+ * @ingroup peripheral_apis
*
* @section rcc_f2_api_ex Reset and Clock Control API.
*
diff --git a/lib/stm32/f3/rcc.c b/lib/stm32/f3/rcc.c
index 7908878f..2a3d2150 100644
--- a/lib/stm32/f3/rcc.c
+++ b/lib/stm32/f3/rcc.c
@@ -1,6 +1,6 @@
-/** @defgroup rcc_file RCC
+/** @defgroup rcc_file RCC Peripheral API
*
- * @ingroup STM32F3xx
+ * @ingroup peripheral_apis
*
* @brief <b>libopencm3 STM32F3xx Reset and Clock Control</b>
*
diff --git a/lib/stm32/f4/rcc.c b/lib/stm32/f4/rcc.c
index a20ce865..74778410 100644
--- a/lib/stm32/f4/rcc.c
+++ b/lib/stm32/f4/rcc.c
@@ -1,6 +1,6 @@
-/** @defgroup rcc_file RCC
+/** @defgroup rcc_file RCC Peripheral API
*
- * @ingroup STM32F4xx
+ * @ingroup peripheral_apis
*
* @section rcc_f4_api_ex Reset and Clock Control API.
*
diff --git a/lib/stm32/f7/rcc.c b/lib/stm32/f7/rcc.c
index 186109a5..64b27427 100644
--- a/lib/stm32/f7/rcc.c
+++ b/lib/stm32/f7/rcc.c
@@ -1,8 +1,19 @@
+/** @defgroup rcc_file RCC Peripheral API
+ *
+ * @ingroup peripheral_apis
+ * This library supports the Reset and Clock Control System in the STM32 series
+ * of ARM Cortex Microcontrollers by ST Microelectronics.
+ *
+ * LGPL License Terms @ref lgpl_license
+ */
+
#include <libopencm3/cm3/assert.h>
#include <libopencm3/stm32/rcc.h>
#include <libopencm3/stm32/pwr.h>
#include <libopencm3/stm32/flash.h>
+/**@{*/
+
uint32_t rcc_ahb_frequency = 16000000;
uint32_t rcc_apb1_frequency = 16000000;
uint32_t rcc_apb2_frequency = 16000000;
@@ -472,3 +483,5 @@ void rcc_clock_setup_hsi(const struct rcc_clock_scale *clock)
rcc_apb1_frequency = clock->apb1_frequency;
rcc_apb2_frequency = clock->apb2_frequency;
}
+
+/**@}*/ \ No newline at end of file
diff --git a/lib/stm32/l0/rcc.c b/lib/stm32/l0/rcc.c
index 4f902f87..a2a1b3c0 100644
--- a/lib/stm32/l0/rcc.c
+++ b/lib/stm32/l0/rcc.c
@@ -1,6 +1,6 @@
-/** @defgroup STM32L0xx-rcc-file RCC
+/** @defgroup rcc_file RCC peripheral API
*
- * @ingroup STM32L0xx
+ * @ingroup peripheral_apis
*
* @brief <b>libopencm3 STM32L0xx Reset and Clock Control</b>
*
diff --git a/lib/stm32/l1/rcc.c b/lib/stm32/l1/rcc.c
index 41cf1999..6d4ddfa7 100644
--- a/lib/stm32/l1/rcc.c
+++ b/lib/stm32/l1/rcc.c
@@ -1,6 +1,6 @@
-/** @defgroup STM32L1xx-rcc-file RCC
+/** @defgroup rcc_file RCC Peripheral API
-@ingroup STM32L1xx
+@ingroup peripheral_apis
@brief <b>libopencm3 STM32L1xx Reset and Clock Control</b>
diff --git a/lib/stm32/l4/rcc.c b/lib/stm32/l4/rcc.c
index f44cfca1..1d3e3472 100644
--- a/lib/stm32/l4/rcc.c
+++ b/lib/stm32/l4/rcc.c
@@ -1,6 +1,6 @@
-/** @defgroup rcc_file RCC
+/** @defgroup rcc_file RCC peripheral API
*
- * @ingroup STM32L4xx
+ * @ingroup peripheral_apis
*
* @section rcc_l4_api_ex Reset and Clock Control API.
*