Fix code-doc

FredM67 · Jun 14, 2023 · f134316 · f134316
1 parent 49311c1
commit f134316
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 3 deletions.
diff --git a/Mk2_3phase_RFdatalog_temp/movingAvg.h b/Mk2_3phase_RFdatalog_temp/movingAvg.h
@@ -1,3 +1,13 @@
+/**
+ * @file movingAvg.h
+ * @author Frédéric Metrich ([email protected])
+ * @brief Code for sliding-window average
+ * @version 0.1
+ * @date 2023-06-14
+ * 
+ * @copyright Copyright (c) 2023
+ * 
+ */
 
 #ifndef MOVINGAVG_H
 #define MOVINGAVG_H

diff --git a/Mk2_3phase_RFdatalog_temp/type_traits.hpp b/Mk2_3phase_RFdatalog_temp/type_traits.hpp
@@ -1,3 +1,14 @@
+/**
+ * @file type_traits.hpp
+ * @author Frédéric Metrich ([email protected])
+ * @brief Some useful but missing stl functions templates
+ * @version 0.1
+ * @date 2023-06-14
+ * 
+ * @copyright Copyright (c) 2023
+ * 
+ */
+
 // ArduinoJson - https://arduinojson.org
 // Copyright © 2014-2023, Benoit BLANCHON
 // MIT License

diff --git a/Mk2_3phase_RFdatalog_temp/utils_relay.h b/Mk2_3phase_RFdatalog_temp/utils_relay.h
@@ -1,7 +1,7 @@
 /**
  * @file utils_relay.h
  * @author Frédéric Metrich ([email protected])
- * @brief 
+ * @brief Some utility functions for the relay output feature
  * @version 0.1
  * @date 2023-03-31
  * 
@@ -226,8 +226,8 @@ template< uint8_t T = 1 > class relayOutput
   const uint16_t minON{ 5 * 60 };          /**< Minimum duration in seconds the relay is turned ON */
   const uint16_t minOFF{ 5 * 60 };         /**< Minimum duration in seconds the relay is turned OFF */
 
-  uint16_t duration{ 0 };   /**< Duration of the current state */
-  bool relayState{ false }; /**< State of the relay */
+  uint16_t duration{ 0 };                  /**< Duration of the current state */
+  bool relayState{ false };                /**< State of the relay */
 
   static inline movingAvg< int16_t, T * 60 / DATALOG_PERIOD_IN_SECONDS > sliding_Average;
 };