diff options
Diffstat (limited to 'src/qdoc/doc/examples/minimum.qdocconf')
| -rw-r--r-- | src/qdoc/doc/examples/minimum.qdocconf | 48 |
1 files changed, 29 insertions, 19 deletions
diff --git a/src/qdoc/doc/examples/minimum.qdocconf b/src/qdoc/doc/examples/minimum.qdocconf index 8f53ffc11..fca0cd757 100644 --- a/src/qdoc/doc/examples/minimum.qdocconf +++ b/src/qdoc/doc/examples/minimum.qdocconf @@ -1,10 +1,16 @@ -# 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. +# 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) -# QDoc needs lists of file extensions to know which files to process in +# 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) @@ -13,24 +19,28 @@ 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 outputdir variable specifies the directory where QDoc places the generated +# documentation. +outputdir = public -# The headerdirs variable specifies the directories -# containing the header files associated -# with the .cpp source files used in the documentation. +# 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 containing the .cpp or .qdoc -# files used in the documentation. +# The sourcedirs variable specifies the directories that contain the .cpp or +# .qdoc files used in the documentation. sourcedirs = . -# The exampledirs variable specifies the directories containing -# the source code of the example files. -exampledirs = . +# The exampledirs variable specifies the directories that contain the source +# code of the example files. +exampledirs = ./examples -# The imagedirs variable specifies the -# directories containing the images used in the documentation. +# 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 |