bsp/stm32h7: Add and use BSP Doxygen group

Inspired by:

commit fe58f6ce4b
Author: Sebastian Huber <sebastian.huber@embedded-brains.de>
Date:   Thu Nov 26 08:13:52 2020 +0100

    bsp/stm32h7: Add and use BSP Doxygen group

    Update #3910.
This commit is contained in:
Karel Gardas
2023-07-21 14:24:09 +02:00
parent 7f3dc31336
commit ba8ac65929
232 changed files with 3729 additions and 0 deletions

View File

@@ -327,6 +327,7 @@
*/
/** @defgroup I2C I2C
* @ingroup RTEMSBSPsARMSTM32H7
* @brief I2C HAL module driver
* @{
*/
@@ -337,6 +338,7 @@
/* Private define ------------------------------------------------------------*/
/** @defgroup I2C_Private_Define I2C Private Define
* @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define TIMING_CLEAR_MASK (0xF0FFFFFFU) /*!< I2C TIMING clear register Mask */
@@ -408,6 +410,7 @@
/* Private function prototypes -----------------------------------------------*/
/** @defgroup I2C_Private_Functions I2C Private Functions
* @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/* Private functions to handle DMA transfer */
@@ -484,10 +487,12 @@ static void I2C_ConvertOtherXferOptions(I2C_HandleTypeDef *hi2c);
/* Exported functions --------------------------------------------------------*/
/** @defgroup I2C_Exported_Functions I2C Exported Functions
* @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/** @defgroup I2C_Exported_Functions_Group1 Initialization and de-initialization functions
* @ingroup RTEMSBSPsARMSTM32H7
* @brief Initialization and Configuration functions
*
@verbatim
@@ -1021,6 +1026,7 @@ HAL_StatusTypeDef HAL_I2C_UnRegisterAddrCallback(I2C_HandleTypeDef *hi2c)
*/
/** @defgroup I2C_Exported_Functions_Group2 Input and Output operation functions
* @ingroup RTEMSBSPsARMSTM32H7
* @brief Data transfers functions
*
@verbatim
@@ -4592,6 +4598,7 @@ HAL_StatusTypeDef HAL_I2C_Master_Abort_IT(I2C_HandleTypeDef *hi2c, uint16_t DevA
*/
/** @defgroup I2C_IRQ_Handler_and_Callbacks IRQ Handler and Callbacks
* @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -4834,6 +4841,7 @@ __weak void HAL_I2C_AbortCpltCallback(I2C_HandleTypeDef *hi2c)
*/
/** @defgroup I2C_Exported_Functions_Group3 Peripheral State, Mode and Error functions
* @ingroup RTEMSBSPsARMSTM32H7
* @brief Peripheral State, Mode and Error functions
*
@verbatim