From a218914c0aebb31aba0281a20840803edea6dac1 Mon Sep 17 00:00:00 2001 From: Libor Polčák Date: Apr 29 2021 21:05:11 +0000 Subject: Doxygen: populate the generated docs with texts * Use the README/index as the main page * Inlude LICENSE and CODING_STYLE * Use the web pages as related files --- diff --git a/doxyfile b/doxyfile index a119fde..9b9758d 100644 --- a/doxyfile +++ b/doxyfile @@ -323,7 +323,7 @@ OPTIMIZE_OUTPUT_SLICE = NO # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. -EXTENSION_MAPPING = js=Javascript +EXTENSION_MAPPING = js=Javascript,no_extension=md # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable @@ -829,7 +829,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = common firefox chrome +INPUT = common firefox chrome docs CODING_STYLE LICENSE # 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 @@ -855,7 +855,8 @@ INPUT_ENCODING = UTF-8 # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.js \ - *.json + *.json \ + *.md # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. @@ -979,7 +980,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = docs/index.md #--------------------------------------------------------------------------- # Configuration options related to source browsing