Fixed documentation findings

BlueAndi · Nov 9, 2023 · 7daa944 · 7daa944
1 parent 1ba4cfa
commit 7daa944
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/lib/APPRemoteControl/SerialMuxChannels.h b/lib/APPRemoteControl/SerialMuxChannels.h
@@ -88,14 +88,14 @@ typedef struct _CommandResponse
 /** Struct of the "Speed" channel payload. */
 typedef struct _SpeedData
 {
-    int16_t left;  /**< Left motor speed */
-    int16_t right; /**< Right motor speed */
+    int16_t left;  /**< Left motor speed [steps/s] */
+    int16_t right; /**< Right motor speed [steps/s] */
 } __attribute__((packed)) SpeedData;
 
 /** Struct of the "Line Sensor" channel payload. */
 typedef struct _LineSensorData
 {
-    uint16_t lineSensorData[5U]; /**< Line sensor data */
+    uint16_t lineSensorData[5U]; /**< Line sensor data [digits] normalized to max 1000 digits. */
 } __attribute__((packed)) LineSensorData;
 
 /******************************************************************************

diff --git a/lib/Service/Logging.h b/lib/Service/Logging.h
@@ -43,27 +43,27 @@
 #ifndef LOG_FATAL_ENABLE
 /** Enable/disable fatal log messages. */
 #define LOG_FATAL_ENABLE (1)
-#endif
+#endif /* LOG_FATAL_ENABLE */
 
 #ifndef LOG_ERROR_ENABLE
 /** Enable/disable error log messages. */
 #define LOG_ERROR_ENABLE (1)
-#endif
+#endif /* LOG_ERROR_ENABLE */
 
 #ifndef LOG_WARNING_ENABLE
 /** Enable/disable warning log messages. */
 #define LOG_WARNING_ENABLE (1)
-#endif
+#endif /* LOG_WARNING_ENABLE */
 
 #ifndef LOG_INFO_ENABLE
 /** Enable/disable info log messages. */
 #define LOG_INFO_ENABLE (1)
-#endif
+#endif /* LOG_INFO_ENABLE */
 
 #ifndef LOG_DEBUG_ENABLE
 /** Enable/disable debug log messages. */
 #define LOG_DEBUG_ENABLE (0)
-#endif
+#endif /* LOG_DEBUG_ENABLE */
 
 /******************************************************************************
  * Includes