AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: added excludedirs to qdocconf example.

Browse Source 
Corrected style issues pointed out in review.

Task-number: QTBUG-31801

Change-Id: Ibbc4e5f8dcd8ca129ae945b5e62b15daed47d86d
Reviewed-by: Martin Smith <martin.smith@digia.com>
This commit is contained in:
Nico Vertriest 2013-08-22 10:28:36 +02:00 committed by The Qt Project
parent 3e7c77cfae
commit 6d0d5a2ade
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/tools/qdoc/doc/qtgui-qdocconf.qdoc
View File

@ -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
@ -272,15 +274,31 @@ associated with the \e .cpp source files.
Add the specified directories to the list of directories containing the \e .cpp and
\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 \