diff options
author | Sergio Ahumada <sergio.ahumada@digia.com> | 2013-09-02 15:07:53 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-09-02 16:26:21 +0200 |
commit | 0a3eb0fe443f8158d81d97cde8f0c9a9632fb9f0 (patch) | |
tree | 7bbdc72a7e30e23fc66a610ff7e3cd298711e5b1 /src/tools/qdoc/doc/qtgui-qdocconf.qdoc | |
parent | cee7380c0470dc591e2aafb3225641d4194ab05c (diff) | |
parent | 190fa97c83472863fd886e86f626ab8196ed51b3 (diff) |
Merge "Merge remote-tracking branch 'origin/stable' into dev" into refs/staging/dev
Diffstat (limited to 'src/tools/qdoc/doc/qtgui-qdocconf.qdoc')
-rw-r--r-- | src/tools/qdoc/doc/qtgui-qdocconf.qdoc | 18 |
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 \ |