From 31b40a863bcf0266973937faefc47e949ba6b77f Mon Sep 17 00:00:00 2001 From: Marian Buschsieweke Date: Fri, 16 Sep 2022 11:12:10 +0200 Subject: [PATCH] drivers/sht1x: document parameters --- drivers/sht1x/include/sht1x_params.h | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/drivers/sht1x/include/sht1x_params.h b/drivers/sht1x/include/sht1x_params.h index 02b94c784d..b6a1775c65 100644 --- a/drivers/sht1x/include/sht1x_params.h +++ b/drivers/sht1x/include/sht1x_params.h @@ -32,15 +32,29 @@ extern "C" { * @{ */ #ifndef SHT1X_PARAM_CLK +/** + * @brief SHT1x the clock pin + */ #define SHT1X_PARAM_CLK (GPIO_PIN(1, 25)) #endif #ifndef SHT1X_PARAM_DATA +/** + * @brief SHT1x the data pin + */ #define SHT1X_PARAM_DATA (GPIO_PIN(1, 26)) #endif #ifndef SHT1X_PARAM_VDD +/** + * @brief SHT1x the supply voltage + * + * @see sht1x_vdd_t + */ #define SHT1X_PARAM_VDD (SHT1X_VDD_3_5V) #endif #ifndef SHT1X_PARAMS +/** + * @brief The initialization parameters for the SHT1x driver + */ #define SHT1X_PARAMS { .clk = SHT1X_PARAM_CLK, \ .data = SHT1X_PARAM_DATA, \ .vdd = SHT1X_PARAM_VDD }