From e024e6f2aca89be0b02f26df84a7eb59adb687fa Mon Sep 17 00:00:00 2001 From: Daniel Teichmann Date: Tue, 29 Jun 2021 17:04:19 +0200 Subject: Add minimal.qdocconf for QDoc; add docs/ to .gitignore --- .gitignore | 1 + minimal.qdocconf | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 minimal.qdocconf diff --git a/.gitignore b/.gitignore index c2ed7a2..ed52138 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ # This file is used to ignore files which are generated # ---------------------------------------------------------------------------- +docs/ *~ *.autosave *.a diff --git a/minimal.qdocconf b/minimal.qdocconf new file mode 100644 index 0000000..d2f73c2 --- /dev/null +++ b/minimal.qdocconf @@ -0,0 +1,36 @@ +# QDoc is a tool that constantly evolves to suit our needs, +# and there are some compatibility issues between old and new +# practices. For that reason, any QDoc configuration file needs to +# include compat.qdocconf. +#include(compat.qdocconf) + +# QDoc needs lists of file extensions to know which files to process in +# different situations. Uncomment the following include statement to get +# a pre-defined list of file extensions. +#include(fileextensions.qdocconf) + +# You can also specify file extensions manually. +headers.fileextensions = "*.h *.hpp" +sources.fileextensions = "*.cpp *.qml *.qdoc" + +# The outputdir variable specifies the directory +# where QDoc will put the generated documentation. +outputdir = docs + +# The headerdirs variable specifies the directories +# containing the header files associated +# with the .cpp source files used in the documentation. +headerdirs = ./src/ + +# The sourcedirs variable specifies the +# directories containing the .cpp or .qdoc +# files used in the documentation. +sourcedirs = ./src/ + +# The exampledirs variable specifies the directories containing +# the source code of the example files. +#exampledirs = . + +# The imagedirs variable specifies the +# directories containing the images used in the documentation. +imagedirs = ./images -- cgit v1.2.3