bsp/stm32h7: Add and use BSP Doxygen group

Update #3910.
This commit is contained in:
Sebastian Huber
2020-11-26 08:13:52 +01:00
parent 22c3d4f2ed
commit fe58f6ce4b
216 changed files with 3517 additions and 0 deletions

View File

@@ -39,6 +39,7 @@
/* Exported types ------------------------------------------------------------*/
/** @defgroup MDMA_Exported_Types MDMA Exported Types
* @ingroup RTEMSBSPsARMSTM32H7
* @brief MDMA Exported Types
* @{
*/
@@ -248,11 +249,13 @@ typedef struct __MDMA_HandleTypeDef
/* Exported constants --------------------------------------------------------*/
/** @defgroup MDMA_Exported_Constants MDMA Exported Constants
* @ingroup RTEMSBSPsARMSTM32H7
* @brief MDMA Exported constants
* @{
*/
/** @defgroup MDMA_Error_Codes MDMA Error Codes
* @ingroup RTEMSBSPsARMSTM32H7
* @brief MDMA Error Codes
* @{
*/
@@ -272,6 +275,7 @@ typedef struct __MDMA_HandleTypeDef
*/
/** @defgroup MDMA_Request_selection MDMA Request selection
* @ingroup RTEMSBSPsARMSTM32H7
* @brief MDMA_Request_selection
* @{
*/
@@ -336,6 +340,7 @@ typedef struct __MDMA_HandleTypeDef
*/
/** @defgroup MDMA_Transfer_TriggerMode MDMA Transfer Trigger Mode
* @ingroup RTEMSBSPsARMSTM32H7
* @brief MDMA Transfer Trigger Mode
* @{
*/
@@ -349,6 +354,7 @@ typedef struct __MDMA_HandleTypeDef
*/
/** @defgroup MDMA_Priority_level MDMA Priority level
* @ingroup RTEMSBSPsARMSTM32H7
* @brief MDMA Priority level
* @{
*/
@@ -363,6 +369,7 @@ typedef struct __MDMA_HandleTypeDef
/** @defgroup MDMA_Endianness MDMA Endianness
* @ingroup RTEMSBSPsARMSTM32H7
* @brief MDMA Endianness
* @{
*/
@@ -376,6 +383,7 @@ typedef struct __MDMA_HandleTypeDef
*/
/** @defgroup MDMA_Source_increment_mode MDMA Source increment mode
* @ingroup RTEMSBSPsARMSTM32H7
* @brief MDMA Source increment mode
* @{
*/
@@ -394,6 +402,7 @@ typedef struct __MDMA_HandleTypeDef
*/
/** @defgroup MDMA_Destination_increment_mode MDMA Destination increment mode
* @ingroup RTEMSBSPsARMSTM32H7
* @brief MDMA Destination increment mode
* @{
*/
@@ -412,6 +421,7 @@ typedef struct __MDMA_HandleTypeDef
*/
/** @defgroup MDMA_Source_data_size MDMA Source data size
* @ingroup RTEMSBSPsARMSTM32H7
* @brief MDMA Source data size
* @{
*/
@@ -425,6 +435,7 @@ typedef struct __MDMA_HandleTypeDef
*/
/** @defgroup MDMA_Destination_data_size MDMA Destination data size
* @ingroup RTEMSBSPsARMSTM32H7
* @brief MDMA Destination data size
* @{
*/
@@ -438,6 +449,7 @@ typedef struct __MDMA_HandleTypeDef
*/
/** @defgroup MDMA_data_Alignment MDMA data alignment
* @ingroup RTEMSBSPsARMSTM32H7
* @brief MDMA data alignment
* @{
*/
@@ -453,6 +465,7 @@ typedef struct __MDMA_HandleTypeDef
*/
/** @defgroup MDMA_Source_burst MDMA Source burst
* @ingroup RTEMSBSPsARMSTM32H7
* @brief MDMA Source burst
* @{
*/
@@ -470,6 +483,7 @@ typedef struct __MDMA_HandleTypeDef
*/
/** @defgroup MDMA_Destination_burst MDMA Destination burst
* @ingroup RTEMSBSPsARMSTM32H7
* @brief MDMA Destination burst
* @{
*/
@@ -487,6 +501,7 @@ typedef struct __MDMA_HandleTypeDef
*/
/** @defgroup MDMA_interrupt_enable_definitions MDMA interrupt enable definitions
* @ingroup RTEMSBSPsARMSTM32H7
* @brief MDMA interrupt enable definitions
* @{
*/
@@ -501,6 +516,7 @@ typedef struct __MDMA_HandleTypeDef
*/
/** @defgroup MDMA_flag_definitions MDMA flag definitions
* @ingroup RTEMSBSPsARMSTM32H7
* @brief MDMA flag definitions
* @{
*/
@@ -522,6 +538,7 @@ typedef struct __MDMA_HandleTypeDef
/* Exported macro ------------------------------------------------------------*/
/** @defgroup MDMA_Exported_Macros MDMA Exported Macros
* @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -615,11 +632,13 @@ typedef struct __MDMA_HandleTypeDef
/* Exported functions --------------------------------------------------------*/
/** @defgroup MDMA_Exported_Functions MDMA Exported Functions
* @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/* Initialization and de-initialization functions *****************************/
/** @defgroup MDMA_Exported_Functions_Group1 Initialization and de-initialization functions
* @ingroup RTEMSBSPsARMSTM32H7
* @brief Initialization and de-initialization functions
* @{
*/
@@ -636,6 +655,7 @@ HAL_StatusTypeDef HAL_MDMA_UnRegisterCallback(MDMA_HandleTypeDef *hmdma, HAL_MDM
/* Linked list operation functions ********************************************/
/** @defgroup MDMA_Exported_Functions_Group2 Linked List operation functions
* @ingroup RTEMSBSPsARMSTM32H7
* @brief Linked list operation functions
* @{
*/
@@ -653,6 +673,7 @@ HAL_StatusTypeDef HAL_MDMA_LinkedList_DisableCircularMode(MDMA_HandleTypeDef *hm
/* IO operation functions *****************************************************/
/** @defgroup MDMA_Exported_Functions_Group3 I/O operation functions
* @ingroup RTEMSBSPsARMSTM32H7
* @brief I/O operation functions
* @{
*/
@@ -670,6 +691,7 @@ void HAL_MDMA_IRQHandler(MDMA_HandleTypeDef *hmdma);
/* Peripheral State and Error functions ***************************************/
/** @defgroup MDMA_Exported_Functions_Group4 Peripheral State functions
* @ingroup RTEMSBSPsARMSTM32H7
* @brief Peripheral State functions
* @{
*/
@@ -686,6 +708,7 @@ uint32_t HAL_MDMA_GetError(MDMA_HandleTypeDef *hmdma);
/* Private types -------------------------------------------------------------*/
/** @defgroup MDMA_Private_Types MDMA Private Types
* @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -695,6 +718,7 @@ uint32_t HAL_MDMA_GetError(MDMA_HandleTypeDef *hmdma);
/* Private defines -----------------------------------------------------------*/
/** @defgroup MDMA_Private_Defines MDMA Private Defines
* @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -704,6 +728,7 @@ uint32_t HAL_MDMA_GetError(MDMA_HandleTypeDef *hmdma);
/* Private variables ---------------------------------------------------------*/
/** @defgroup MDMA_Private_Variables MDMA Private Variables
* @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -713,6 +738,7 @@ uint32_t HAL_MDMA_GetError(MDMA_HandleTypeDef *hmdma);
/* Private constants ---------------------------------------------------------*/
/** @defgroup MDMA_Private_Constants MDMA Private Constants
* @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -722,6 +748,7 @@ uint32_t HAL_MDMA_GetError(MDMA_HandleTypeDef *hmdma);
/* Private macros ------------------------------------------------------------*/
/** @defgroup MDMA_Private_Macros MDMA Private Macros
* @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -822,6 +849,7 @@ uint32_t HAL_MDMA_GetError(MDMA_HandleTypeDef *hmdma);
/* Private functions prototypes ----------------------------------------------*/
/** @defgroup MDMA_Private_Functions_Prototypes MDMA Private Functions Prototypes
* @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -831,6 +859,7 @@ uint32_t HAL_MDMA_GetError(MDMA_HandleTypeDef *hmdma);
/* Private functions ---------------------------------------------------------*/
/** @defgroup MDMA_Private_Functions MDMA Private Functions
* @ingroup RTEMSBSPsARMSTM32H7
* @{
*/