From 72625b6696146dde419ef7c70eb14e9004cb57d4 Mon Sep 17 00:00:00 2001
From: babayaga <cgoflyn@gmail.com>
Date: Fri, 23 May 2025 19:34:48 +0200
Subject: [PATCH] clean with kbot :)

---
 src/modbus/Modbus.h | 69 +++++++++++++++++++++++++++++++--------------
 1 file changed, 48 insertions(+), 21 deletions(-)

diff --git a/src/modbus/Modbus.h b/src/modbus/Modbus.h
index 8aa143f5..a426e231 100644
--- a/src/modbus/Modbus.h
+++ b/src/modbus/Modbus.h
@@ -1,32 +1,59 @@
-#ifndef MODBUS_H
-#define MODBUS_H
+#ifndef MODBUS_H
+#define MODBLUSEH
 
 #include <inttypes.h>
 #include "ModbusTypes.h"
 
-#define INIT_MODBUS_BLOCK_TCP(tcpBaseAddr, offset_enum, fn_code, access, desc, group) \
+/**
+ * @defgroup modbus_macros Modbus Macros
+ * @brief Macros for initializing Modbus communication blocks
+ * @details These macros provide a standardized way to initialize Modbus block structures
+ * for both TCP and standard interfaces, automating address calculations and parameter setting.
+ * @{
+ */
+
+/**
+ * @brief Initializes Modbus block with TCP base address
+ * @param tcpBaseAddr TCP base address for calculation
+ * @param offset_enum Enum value representing address offset
+ * @param fn_code Modbus function code
+ * @param access Access flags for read/write permissions
+ * @param desc Description string for documentation
+ * @param group Group identifier for organization
+ */
+#define INIT_MODBLUSE_BLOCK_TCP(tcpBaseAddr, offset_enum, fn_code, access, desc, group) \
     { \
-        static_cast<ushort>(tcpBaseAddr + static_cast<ushort>(offset_enum)), /* startAddress */ \
-        1,                                           /* numRegisters */ \
-        fn_code,                                     /* functionCode */ \
-        access,                                      /* accessFlags */ \
-        this->id,                                    /* componentId */ \
-        this->slaveId,                               /* slaveId */ \
-        desc,                                        /* description */ \
-        group                                        /* group */ \
+        static_cast<ushort>(tcpBaseAddr + static_cast<ushort>(offset_enum)), \
+        1, \
+        fn_code, \
+        access, \
+        this->id, \
+        this->slaveId, \
+        desc, \
+        group \
     }
 
-#define INIT_MODBUS_BLOCK(offset_enum, fn_code, access, desc, group) \
+/**
+ * @brief Initializes standard Modbus block
+ * @note Requires tcpBaseAddr variable in scope
+ * @param offset_enum Enum value representing address offset
+ * @param fn_code Modbus function code
+ * @param access Access flags for read/write permissions
+ * @param desc Description string for documentation
+ * @param group Group identifier for organization
+ */
+#define INIT_MODBUSE_BLOCK(offset_enum, fn_code, access, desc, group) \
     { \
-        static_cast<ushort>(tcpBaseAddr + static_cast<ushort>(offset_enum)), /* startAddress */ \
-        1,                                           /* numRegisters */ \
-        fn_code,                                     /* functionCode */ \
-        access,                                      /* accessFlags */ \
-        this->id,                                    /* componentId */ \
-        this->slaveId,                               /* slaveId */ \
-        desc,                                        /* description */ \
-        group                                        /* group */ \
+        static_cast<ushort>(tcpBaseAddr + static_cast<ushort>(offset_enum)), \
+        1, \
+        fn_code, \
+        access, \
+        this->id, \
+        this->slaveId, \
+        desc, \
+        group \
     }
 
-#endif
+/** @} */
 
+#endif
\ No newline at end of file