documentation for tm1637_params.h

drivers/include/tm1637.h

@@ -1,3 +1,25 @@
+/*
+ * Copyright (C) 2024 Nico Behrens <[email protected]>
+ *
+ * This file is subject to the terms and conditions of the GNU Lesser
+ * General Public License v2.1. See the file LICENSE in the top level
+ * directory for more details.
+ */
+
+/**
+ * @defgroup    drivers_tm1637 TM1637 display
+ * @ingroup     drivers_tm1637
+ * @brief       Driver for the TM1637 4-digit 7-segment display
+ *
+ * @{
+ * @file
+ * @brief       Interface definition for the TM1637 4-digit 7-segment display driver
+ *
+ * @author      Nico Behrens <[email protected]>
+ *
+ * @}
+ */
+
 #ifndef TM1637_H
 #define TM1637_H
 

drivers/tm1637/include/tm1637_params.h

@@ -26,18 +26,30 @@ extern "C" {
 #endif
 
 #ifndef TM1637_PARAM_CLK
+/**
+ * @brief see @ref tm1637_params_t
+ */
 #define TM1637_PARAM_CLK GPIO_PIN(0, 0)
 #endif
 
 #ifndef TM1637_PARAM_DIO
+/**
+ * @brief see @ref tm1637_params_t
+ */
 #define TM1637_PARAM_DIO GPIO_PIN(0, 1)
 #endif
 
 #ifndef TM1637_PARAMS
+/**
+ * @brief see @ref tm1637_params_t
+ */
 #define TM1637_PARAMS { .clk = TM1637_PARAM_CLK, \
                         .dio = TM1637_PARAM_DIO }
 #endif
 
+/**
+ * @brief see @ref tm1637_params_t
+ */
 static const tm1637_params_t tm1637_params[] = {
     TM1637_PARAMS
 };