summaryrefslogtreecommitdiffstats
path: root/src/tools/qdoc/doc/qtgui-qdocconf.qdoc
diff options
context:
space:
mode:
authorFrederik Gladhorn <frederik.gladhorn@digia.com>2013-08-27 22:51:09 +0200
committerFrederik Gladhorn <frederik.gladhorn@digia.com>2013-08-27 22:51:09 +0200
commit190fa97c83472863fd886e86f626ab8196ed51b3 (patch)
tree49edb9f6a41d6c999c9bb43ae28911a8e7212757 /src/tools/qdoc/doc/qtgui-qdocconf.qdoc
parent3aa163491c9c8f28c88ac87cafc6418f2c0e46c5 (diff)
parent5971e0918757737425151c39a5f81a238663a17a (diff)
Merge remote-tracking branch 'origin/stable' into dev
Conflicts: examples/widgets/doc/src/addressbook-fr.qdoc Change-Id: Id1196e8e0c6445f1616c3f29234c974d809f8e48
Diffstat (limited to 'src/tools/qdoc/doc/qtgui-qdocconf.qdoc')
-rw-r--r--src/tools/qdoc/doc/qtgui-qdocconf.qdoc18
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 += .. \
../../../examples/gui/doc/src
+ excludedirs = ../../../examples/gui/doc/src/tmp
+
exampledirs += ../../../examples/gui \
snippets
@@ -273,14 +275,30 @@ Add the specified directories to the list of directories containing the \e .cpp
\e .qdoc files used in the documentation.
\code
+ excludedirs = ../../../examples/gui/doc/src/tmp
+\endcode
+
+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
+variables.
+
+When executed, QDoc will ignore the directories listed.
+\sa excludefiles
+
+\code
exampledirs += ../../../examples/gui \
snippets
\endcode
+\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.
+
\code
imagedirs += images \
../../../examples/gui/doc/images \