Cleanup doxygen

This commit is contained in:
Henrik Stickann
2023-01-31 21:14:02 +01:00
parent a7466d6417
commit 4204c028a2
24 changed files with 89 additions and 154 deletions

View File

@@ -1,6 +1,12 @@
/**
* @file
* @brief Delay functions.
*
* Configuration:
* * STA_STM32_DELAY_US_TIM: 1 MHz TIM instance used by sta::delayUs
*
* NOTE: TIM time base must be started before use of sta::delayUs by calling sta::initHAL.
* When using startup system task this is handled automatically.
*/
#ifndef STA_CORE_STM32_DELAY_HPP
#define STA_CORE_STM32_DELAY_HPP
@@ -11,23 +17,9 @@
* @brief STM32 Delay module.
*/
#ifdef DOXYGEN
/**
* @def STA_STM32_DELAY_US_TIM
* @brief 1 MHz TIM instance used by sta::delayUs.
*
* NOTE: TIM time base must be started before use of sta::delayUs by calling sta::initHAL.
* When using startup system task this is handled automatically.
*
* @ingroup stm32BuildConfig
*/
# define STA_STM32_DELAY_US_TIM
#endif // DOXYGEN
// Only enable module on STM32 platform
#include <sta/config.hpp>
#ifdef STA_PLATFORM_STM32
#if defined(STA_PLATFORM_STM32) || defined(DOXYGEN)
#include <cstdint>
@@ -43,7 +35,7 @@ namespace sta
*/
void delayMs(uint32_t ms);
#ifdef STA_STM32_DELAY_US_TIM
#if defined(STA_STM32_DELAY_US_TIM) || defined(DOXYGEN)
/**
* @brief Microsecond delay.
*