From b2502a31e95ce43bd6786694af55cdfde6ce97bc Mon Sep 17 00:00:00 2001 From: Jens True Date: Fri, 17 Dec 2021 10:21:41 +0000 Subject: [PATCH] Documenting private members --- Doxyfile | 1 + lib/DisplayProxy/DisplayProxyMAX7456.h | 3 +++ platformio.ini | 2 +- 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/Doxyfile b/Doxyfile index 155587a..0a051b4 100644 --- a/Doxyfile +++ b/Doxyfile @@ -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 diff --git a/lib/DisplayProxy/DisplayProxyMAX7456.h b/lib/DisplayProxy/DisplayProxyMAX7456.h index a15497c..7158b41 100644 --- 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; }; diff --git a/platformio.ini b/platformio.ini index a88f5aa..27fb905 100644 --- 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 \ No newline at end of file +lib_deps = ArduinoJson@6.18.5, git+https://github.com/Avamander/max7456#4fec91e \ No newline at end of file