blob: fca0cd757de32fdd8cd7518f459ba4a6be854a8d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
# QDoc is a tool that constantly evolves and there may be compatibility issues
# between old and new practices. For that reason, QDoc configuration files in
# the Qt Project includes compat.qdocconf:
#include(compat.qdocconf)
# Give the documentation project a title:
project = My documentation project
# Pass additional include paths to QDoc when parsing C++ code for documentation
# comments.
#includepaths += -I/some/path
# QDoc needs a 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 places the generated
# documentation.
outputdir = public
# The headerdirs variable specifies the directories that contain the header
# files associated with the .cpp source files used in the documentation.
headerdirs = .
# The sourcedirs variable specifies the directories that contain the .cpp or
# .qdoc files used in the documentation.
sourcedirs = .
# The exampledirs variable specifies the directories that contain the source
# code of the example files.
exampledirs = ./examples
# The imagedirs variable specifies the directories that contain images used in
# the documentation.
imagedirs = ./images
# Set a warning limit. QDoc will exit with a non-zero exit code if it generates
# documentation warnings during the documentation build. Useful for tracking
# down documentation issues.
#warninglimit = 0
#warninglimit.enabled = true
|
