Fix warnings

.drone.yml

@@ -7,7 +7,7 @@ steps:
   commands:
   - pip install platformio
   - pio run
-  - pio check --skip-packages > StaticCodeAnalysisReport.txt
+  - pio check --skip-packages --fail-on-defect medium > StaticCodeAnalysisReport.txt
 - name: docs
   image: corentinaltepe/doxygen
   commands:

Doxyfile

@@ -1,6 +1,6 @@
 PROJECT_NAME     = "MinimOSD-JSON"
 OUTPUT_DIRECTORY = "docs/"
-INPUT            = "README.md" "src" "lib"
+INPUT            = "README.md" "src" "lib" "include"
 RECURSIVE        = YES
 WARNINGS         = YES
 GENERATE_LATEX   = NO

include/config.h

@@ -1,20 +1,38 @@
+/**
+ * @file config.h
+ * @author Jens True (jens.chr.true@gmail.com)
+ * @brief Global configuration
+ * @version 0.1
+ * @date 2021-11-10
+ * 
+ * @copyright Copyright (c) 2021
+ * 
+ */
 #ifndef CONFIG_H
 #define CONFIG_H
 
+/**
+ * Helper for joining strings
+ */
 #define STR_HELPER(x) #x
+/**
+ * Stringify macro defines
+ */
 #define STR(x) STR_HELPER(x)
 
-#define PROJECT_NAME            "MinimOSD-JSON"
-#define VERSION_MAJOR           0
-#define VERSION_MINOR           1
-#define VERSION_BUILD           1
+
+#define PROJECT_NAME            "MinimOSD-JSON" /**< Project name */
+#define VERSION_MAJOR           0               /**< Major version number */
+#define VERSION_MINOR           1               /**< Minor version number */
+#define VERSION_BUILD           1               /**< Build number */
 
 
+/**
+ * Semver style version number
+ */
 #define VERSION_STRING          STR(VERSION_MAJOR) "." STR(VERSION_MINOR) "." STR(VERSION_BUILD)
-#define VERSION_DATE            __DATE__
 
-
-#define BAUDRATE                115200
-#define DISP_OFFSET_X           49
-#define DISP_OFFSET_Y           27
+#define BAUDRATE                115200  /**< Serial baudrate */
+#define DISP_OFFSET_X           49      /**< Display offset along the X-axis. Varies from display to display. */
+#define DISP_OFFSET_Y           27      /**< Display offset along the Y-axis. Varies from display to display. */
 #endif /* CONFIG_H */

lib/DisplayProxy/DisplayProxyMAX7456.h

@@ -41,11 +41,11 @@ public:
     /**
      * OSD on, external video left untouched.
      */
-    bool on();
+    bool on() override;
     /**
      * OSD off, external video off.
      */
-    bool off();
+    bool off() override;
     /**
      * Depending on the font loaded into the Max7456 the output might not be ASCII compatible.
      */

src/main.cpp

@@ -68,3 +68,19 @@ void loop()
         cmd_handler.parseJSON(input.c_str());
     }
 }
+
+/**
+ * @brief Wrapper around arduino setup/loop functions
+ * 
+ * This mitigates static code analysis warnings.
+ * 
+ * @return int 
+ */
+int main()
+{
+    setup();
+    while(1)
+    {
+        loop();
+    }
+}