path: root/src/tools/qdoc/doc/qtgui-qdocconf.qdoc
diff options
authorNico Vertriest <>2013-08-22 10:28:36 +0200
committerThe Qt Project <>2013-08-23 11:48:00 +0200
commit6d0d5a2adeff94fa483c8d6b370493e604f77ccd (patch)
tree09c32845cb1e30b6ba7fac21b0cdf9d61e1a1e02 /src/tools/qdoc/doc/qtgui-qdocconf.qdoc
parent3e7c77cfaeab06d20945fcaba2fe25cdaa5a74be (diff)
Doc: added excludedirs to qdocconf example.
Corrected style issues pointed out in review. Task-number: QTBUG-31801 Change-Id: Ibbc4e5f8dcd8ca129ae945b5e62b15daed47d86d Reviewed-by: Martin Smith <>
Diffstat (limited to 'src/tools/qdoc/doc/qtgui-qdocconf.qdoc')
1 files changed, 18 insertions, 0 deletions
diff --git a/src/tools/qdoc/doc/qtgui-qdocconf.qdoc b/src/tools/qdoc/doc/qtgui-qdocconf.qdoc
index 7e6da0feb5..767934986f 100644
--- a/src/tools/qdoc/doc/qtgui-qdocconf.qdoc
+++ b/src/tools/qdoc/doc/qtgui-qdocconf.qdoc
@@ -83,6 +83,8 @@ every statement in the qdocconf file.
sourcedirs += .. \
+ excludedirs = ../../../examples/gui/doc/src/tmp
exampledirs += ../../../examples/gui \
@@ -273,14 +275,30 @@ Add the specified directories to the list of directories containing the \e .cpp
\e .qdoc files used in the documentation.
+ excludedirs = ../../../examples/gui/doc/src/tmp
+The \c excludedirs variable is for listing directories that should not be processed
+by qdoc, even if the same directories are included by the \c sourcedirs or \c headerdirs
+When executed, QDoc will ignore the directories listed.
+\sa excludefiles
exampledirs += ../../../examples/gui \
+\sa examples
\sa examplesinstallpath
Add the two directories specified to the list of directories containing the source
code of the example files.
+If QDoc encounters both \c exampledirs and \c examples, it will look first in the
+\c examples directory. QDoc will accept the first matching file it finds. QDoc will
+search in the directories specified, not in their subdirectories.
imagedirs += images \
../../../examples/gui/doc/images \