Updated: Doxygen Documentation

This commit is contained in:
@CarlWachter
2024-01-06 17:17:40 +01:00
committed by CarlWachter
parent b3ed26e288
commit 16b9e6135c
26 changed files with 331 additions and 306 deletions

View File

@@ -13,6 +13,11 @@
namespace sta
{
/**
* @brief A wrapper class for the STM32 ADC peripheral.
*
* @ingroup sta_core_stm32
*/
class STM32ADC
{
public:
@@ -27,12 +32,17 @@ namespace sta
void start();
/**
* @brief
* @brief Polls for the converted analog signal.
*
* @param timeout
*/
void poll(uint32_t timeout);
/**
* @brief Get the value of the converted analog signal.
*
* @return uint32_t
*/
uint32_t getValue();
private:
ADC_HandleTypeDef * handle_;