From 40f0d247905003af19933dc48738657cbc2c0c72 Mon Sep 17 00:00:00 2001 From: Loic Guegan Date: Sun, 4 Jun 2023 11:51:31 +0200 Subject: Improve documentation --- tools/doxygen/Doxyfile | 4 +- tools/doxygen/Groups.md | 5 + tools/doxygen/layout.xml | 240 +++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 247 insertions(+), 2 deletions(-) create mode 100644 tools/doxygen/Groups.md create mode 100644 tools/doxygen/layout.xml (limited to 'tools') diff --git a/tools/doxygen/Doxyfile b/tools/doxygen/Doxyfile index ba19246..6ceef09 100644 --- a/tools/doxygen/Doxyfile +++ b/tools/doxygen/Doxyfile @@ -796,7 +796,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = +LAYOUT_FILE = layout.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -917,7 +917,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ../../src MainPage.md Opening.md BoardTheming.md Libraries.md +INPUT = ../../src MainPage.md Opening.md BoardTheming.md Libraries.md Groups.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/tools/doxygen/Groups.md b/tools/doxygen/Groups.md new file mode 100644 index 0000000..aa5bd64 --- /dev/null +++ b/tools/doxygen/Groups.md @@ -0,0 +1,5 @@ +@defgroup binres Embbeded binary resources utilities +@brief How to access to the embbeded binary data +@details Binary resources are generated into the binary_data.hpp file using +the `tools/embbeded.sh` script. Here are the various functions used +to access to them. \ No newline at end of file diff --git a/tools/doxygen/layout.xml b/tools/doxygen/layout.xml new file mode 100644 index 0000000..0b25223 --- /dev/null +++ b/tools/doxygen/layout.xml @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -- cgit v1.2.3