doc:stm32: usart: fix grouping and heirarchy of base addrs

They were always landing on the top level, or not even present.
This commit is contained in:
Karl Palsson
2019-06-11 21:26:12 +00:00
committed by Karl Palsson
parent 9a53dc3a89
commit 867bd164eb
7 changed files with 23 additions and 5 deletions

View File

@@ -39,7 +39,6 @@ specific memorymap.h header before including this header file.*/
/** @defgroup usart_reg_base USART register base addresses /** @defgroup usart_reg_base USART register base addresses
* @ingroup STM32F_usart_defines
* Holds all the U(S)ART peripherals supported. * Holds all the U(S)ART peripherals supported.
* @{ * @{
*/ */

View File

@@ -38,9 +38,14 @@ specific memorymap.h header before including this header file.*/
/* --- Convenience macros -------------------------------------------------- */ /* --- Convenience macros -------------------------------------------------- */
/** @addtogroup usart_reg_base USART register base addresses
* Holds all the U(S)ART peripherals supported.
* @{
*/
#define USART6 USART6_BASE #define USART6 USART6_BASE
#define UART7 UART7_BASE #define UART7 UART7_BASE
#define UART8 UART8_BASE #define UART8 UART8_BASE
/**@}*/
/* --- USART registers ----------------------------------------------------- */ /* --- USART registers ----------------------------------------------------- */

View File

@@ -34,10 +34,16 @@
#include <libopencm3/stm32/common/usart_common_all.h> #include <libopencm3/stm32/common/usart_common_all.h>
#include <libopencm3/stm32/common/usart_common_v2.h> #include <libopencm3/stm32/common/usart_common_v2.h>
/**@{*/
/*****************************************************************************/ /*****************************************************************************/
/* Module definitions */ /* Module definitions */
/*****************************************************************************/ /*****************************************************************************/
/** @defgroup usart_reg_base USART register base addresses
* Holds all the U(S)ART peripherals supported.
* @{
*/
#define USART1 USART1_BASE #define USART1 USART1_BASE
#define USART2 USART2_BASE #define USART2 USART2_BASE
#define USART3 USART3_BASE #define USART3 USART3_BASE
@@ -46,6 +52,7 @@
#define USART6 USART6_BASE #define USART6 USART6_BASE
#define USART7 USART7_BASE #define USART7 USART7_BASE
#define USART8 USART8_BASE #define USART8 USART8_BASE
/**@}*/
/*****************************************************************************/ /*****************************************************************************/
/* Register values */ /* Register values */
@@ -59,5 +66,7 @@ BEGIN_DECLS
END_DECLS END_DECLS
/**@}*/
#endif #endif

View File

@@ -34,9 +34,9 @@
#include <libopencm3/stm32/common/usart_common_all.h> #include <libopencm3/stm32/common/usart_common_all.h>
#include <libopencm3/stm32/common/usart_common_v2.h> #include <libopencm3/stm32/common/usart_common_v2.h>
/**@{*/
/** @defgroup usart_reg_base USART register base addresses /** @defgroup usart_reg_base USART register base addresses
* @ingroup STM32F_usart_defines
* Holds all the U(S)ART peripherals supported. * Holds all the U(S)ART peripherals supported.
* @{ * @{
*/ */
@@ -51,5 +51,7 @@ BEGIN_DECLS
END_DECLS END_DECLS
/**@}*/
#endif #endif

View File

@@ -34,9 +34,9 @@
#include <libopencm3/stm32/common/usart_common_all.h> #include <libopencm3/stm32/common/usart_common_all.h>
#include <libopencm3/stm32/common/usart_common_v2.h> #include <libopencm3/stm32/common/usart_common_v2.h>
/**@{*/
/** @defgroup usart_reg_base USART register base addresses /** @defgroup usart_reg_base USART register base addresses
* @ingroup STM32F_usart_defines
* Holds all the U(S)ART peripherals supported. * Holds all the U(S)ART peripherals supported.
* @{ * @{
*/ */
@@ -54,5 +54,7 @@ BEGIN_DECLS
END_DECLS END_DECLS
/**@}*/
#endif #endif

View File

@@ -30,8 +30,9 @@
#include <libopencm3/stm32/common/usart_common_all.h> #include <libopencm3/stm32/common/usart_common_all.h>
#include <libopencm3/stm32/common/usart_common_v2.h> #include <libopencm3/stm32/common/usart_common_v2.h>
/**@{*/
/** @defgroup usart_reg_base USART register base addresses /** @defgroup usart_reg_base USART register base addresses
* @ingroup STM32F_usart_defines
* Holds all the U(S)ART peripherals supported. * Holds all the U(S)ART peripherals supported.
* @{ * @{
*/ */
@@ -46,4 +47,5 @@ BEGIN_DECLS
END_DECLS END_DECLS
/**@}*/
#endif #endif

View File

@@ -31,7 +31,6 @@
#include <libopencm3/stm32/common/usart_common_v2.h> #include <libopencm3/stm32/common/usart_common_v2.h>
/** @defgroup usart_reg_base USART register base addresses /** @defgroup usart_reg_base USART register base addresses
* @ingroup STM32F_usart_defines
* Holds all the U(S)ART peripherals supported. * Holds all the U(S)ART peripherals supported.
* @{ * @{
*/ */