Centralize defgroups

FredM67 · Mar 10, 2024 · b08d716 · b08d716
1 parent b173d9a
commit b08d716
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 25 deletions.
diff --git a/Mk2_3phase_RFdatalog_temp/Mk2_3phase_RFdatalog_temp.ino b/Mk2_3phase_RFdatalog_temp/Mk2_3phase_RFdatalog_temp.ino
@@ -157,6 +157,32 @@
  * @copyright Copyright (c) 2024
  *
  */
+
+/*!
+ *  @defgroup TimeCritical Time critical functions
+ *  Functions used by the ISR
+ */
+
+/*!
+ *  @defgroup RelayDiversion Relay diversion feature
+ *  Functions used for the relay diversion
+ */
+
+/*!
+ *  @defgroup TemperatureSensing Temperature sensing feature
+ *  Functions used for the temperature sensing
+ */
+
+/*!
+ *  @defgroup DualTariff Dual tariff feature
+ *  Functions used for the dual tariff feature
+ */
+
+/*!
+ *  @defgroup RF RF feature
+ *  Functions used for the RF feature
+ */
+
 static_assert(__cplusplus >= 201703L, "**** Please define 'gnu++17' in 'platform.txt' ! ****");
 static_assert(__cplusplus >= 201703L, "See also : https://github.com/FredM67/PVRouter-3-phase/blob/main/Mk2_3phase_RFdatalog_temp/Readme.md");
 

diff --git a/Mk2_3phase_RFdatalog_temp/processing.cpp b/Mk2_3phase_RFdatalog_temp/processing.cpp
@@ -16,11 +16,6 @@
 #include "processing.h"
 #include "utils_pins.h"
 
-/*!
- *  @defgroup TimeCritical Time critical functions
- *  Functions used by the ISR
- */
-
 int32_t l_DCoffset_V[NO_OF_PHASES]; /**< <--- for LPF */
 
 // Define operating limits for the LP filters which identify DC offset in the voltage

diff --git a/Mk2_3phase_RFdatalog_temp/utils_dualtariff.h b/Mk2_3phase_RFdatalog_temp/utils_dualtariff.h
@@ -14,11 +14,6 @@
 
 #include <Arduino.h>
 
-/*!
- *  @defgroup DualTariff 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,11 +20,6 @@
 #include "ewma_avg.hpp"
 #include "utils_pins.h"
 
-/*!
- *  @defgroup RelayDiversion 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,11 +12,6 @@
 #ifndef _UTILS_RF_H
 #define _UTILS_RF_H
 
-/*!
- *  @defgroup RF 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,11 +16,6 @@
 
 #include "constants.h"
 
-/*!
- *  @defgroup TemperatureSensing 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