Documenting private members

2021-12-17 10:21:41 +00:00
parent 7a23e39078
commit b2502a31e9
3 changed files with 5 additions and 1 deletions
--- a/1
+++ b/1
@ -1,6 +1,7 @@
 PROJECT_NAME     = "MinimOSD-JSON"
 OUTPUT_DIRECTORY = "docs/"
 INPUT            = "README.md" "src" "lib" "include"
+EXTRACT_PRIVATE = YES
 RECURSIVE        = YES
 WARNINGS         = YES
 GENERATE_LATEX   = NO
--- a/lib/DisplayProxy/DisplayProxyMAX7456.h
+++ b/lib/DisplayProxy/DisplayProxyMAX7456.h
@ -73,6 +73,9 @@ public:
    bool onScreenDisplay(bool enabled);

 private:
+    /**
+     * @brief Reference to the OSD instance. 
+     */
    Max7456 *osd;
 };

--- a/platformio.ini
+++ b/platformio.ini
@ -2,4 +2,4 @@
 platform  = atmelavr
 board     = pro16MHzatmega328
 framework = arduino
-lib_deps  = ArduinoJson, git+https://github.com/Avamander/max7456
+lib_deps  = ArduinoJson@6.18.5, git+https://github.com/Avamander/max7456#4fec91e