Some doc tuning

FredM67 · Mar 10, 2024 · ec70ab2 · ec70ab2
1 parent eef1010
commit ec70ab2
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 1 deletion.
diff --git a/Mk2_3phase_RFdatalog_temp/dualtariff.h b/Mk2_3phase_RFdatalog_temp/dualtariff.h
@@ -14,6 +14,11 @@
 
 #include "config.h"
 
+/*!
+ *  @defgroup Dual tariff feature
+ *  Functions used for the dual tariff feature
+ */
+
 /**
  * @brief Template class for Load-Overriding
  * @details The array is initialized at compile time so it can be read-only and

diff --git a/Mk2_3phase_RFdatalog_temp/processing.cpp b/Mk2_3phase_RFdatalog_temp/processing.cpp
@@ -17,7 +17,7 @@
 #include "utils_pins.h"
 
 /*!
- *  @defgroup TimeCritical Time critical functions Group
+ *  @defgroup TimeCritical Time critical functions
  *  Functions used by the ISR
  */
 

diff --git a/Mk2_3phase_RFdatalog_temp/utils_dualtariff.h b/Mk2_3phase_RFdatalog_temp/utils_dualtariff.h
@@ -14,6 +14,11 @@
 
 #include <Arduino.h>
 
+/*!
+ *  @defgroup Dual tariff feature
+ *  Functions used for the dual tariff feature
+ */
+
 /** @brief Config parameters for overriding a load
  *  @details This class allows the user to define when and how long a load will be forced at
  *           full power during off-peak period.

diff --git a/Mk2_3phase_RFdatalog_temp/utils_relay.h b/Mk2_3phase_RFdatalog_temp/utils_relay.h
@@ -20,6 +20,11 @@
 #include "ewma_avg.hpp"
 #include "utils_pins.h"
 
+/*!
+ *  @defgroup Relay diversion feature
+ *  Functions used for the relay diversion
+ */
+
 /**
  * @brief Relay diversion config and engine
  * 

diff --git a/Mk2_3phase_RFdatalog_temp/utils_rf.h b/Mk2_3phase_RFdatalog_temp/utils_rf.h
@@ -12,6 +12,11 @@
 #ifndef _UTILS_RF_H
 #define _UTILS_RF_H
 
+/*!
+ *  @defgroup RF feature
+ *  Functions used for the RF feature
+ */
+
 #ifdef RF_PRESENT
 #include <JeeLib.h>
 

diff --git a/Mk2_3phase_RFdatalog_temp/utils_temp.h b/Mk2_3phase_RFdatalog_temp/utils_temp.h
@@ -16,6 +16,11 @@
 
 #include "constants.h"
 
+/*!
+ *  @defgroup Temperature sensing feature
+ *  Functions used for the temperature sensing
+ */
+
 #ifdef TEMP_ENABLED
 inline constexpr bool TEMP_SENSOR_PRESENT{ true }; /**< set it to 'true' if temperature sensing is needed */
 #include <OneWire.h>                               // for temperature sensing