summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Wicking <paul.wicking@qt.io>2018-12-18 18:55:20 +0100
committerPaul Wicking <paul.wicking@qt.io>2018-12-19 18:16:21 +0000
commitf1a8c05c740aeba25f0e44a0cc11903effdf6e99 (patch)
tree1503a848053737ef90c02896792993f38852f1d1
parent4f94fca62cd1f0b8069bc339ae87108fda3fe498 (diff)
Doc: Update minimum qdocconf
Turn the minimum qdocconf into copypasta material. Change-Id: I923831701f60f5a95b7708326b5bfd669b424edb Reviewed-by: Martin Smith <martin.smith@qt.io>
-rw-r--r--src/qdoc/doc/examples/minimum.qdocconf22
1 files changed, 8 insertions, 14 deletions
diff --git a/src/qdoc/doc/examples/minimum.qdocconf b/src/qdoc/doc/examples/minimum.qdocconf
index 1d686cfe8..8f53ffc11 100644
--- a/src/qdoc/doc/examples/minimum.qdocconf
+++ b/src/qdoc/doc/examples/minimum.qdocconf
@@ -2,41 +2,35 @@
# 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.
+# 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)
-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 = html
-
# The headerdirs variable specifies the directories
# containing the header files associated
# with the .cpp source files used in the documentation.
-
headerdirs = .
-
# The sourcedirs variable specifies the
# directories containing the .cpp or .qdoc
# files used in the documentation.
-
-#sourcedirs = .
-
+sourcedirs = .
# 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