Doc: added excludedirs to qdocconf example.
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:
parent
3e7c77cfae
commit
6d0d5a2ade
@ -83,6 +83,8 @@ every statement in the qdocconf file.
|
|||||||
sourcedirs += .. \
|
sourcedirs += .. \
|
||||||
../../../examples/gui/doc/src
|
../../../examples/gui/doc/src
|
||||||
|
|
||||||
|
excludedirs = ../../../examples/gui/doc/src/tmp
|
||||||
|
|
||||||
exampledirs += ../../../examples/gui \
|
exampledirs += ../../../examples/gui \
|
||||||
snippets
|
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
|
Add the specified directories to the list of directories containing the \e .cpp and
|
||||||
\e .qdoc files used in the documentation.
|
\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
|
\code
|
||||||
exampledirs += ../../../examples/gui \
|
exampledirs += ../../../examples/gui \
|
||||||
snippets
|
snippets
|
||||||
\endcode
|
\endcode
|
||||||
|
\sa examples
|
||||||
\sa examplesinstallpath
|
\sa examplesinstallpath
|
||||||
|
|
||||||
Add the two directories specified to the list of directories containing the source
|
Add the two directories specified to the list of directories containing the source
|
||||||
code of the example files.
|
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
|
\code
|
||||||
imagedirs += images \
|
imagedirs += images \
|
||||||
../../../examples/gui/doc/images \
|
../../../examples/gui/doc/images \
|
||||||
|
Loading…
x
Reference in New Issue
Block a user