summaryrefslogtreecommitdiff
path: root/src/qdoc/doc/qdoc-manual-qdocconf.qdoc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@theqtcompany.com>2016-01-20 15:56:54 +0100
committerTopi Reiniƶ <topi.reinio@theqtcompany.com>2016-01-22 13:41:16 +0000
commit0ea13138a8b8ad324c5bdf2a566fe949766713ef (patch)
tree390fc9e5e7566fc93b85e1eb00f348d5465e8060 /src/qdoc/doc/qdoc-manual-qdocconf.qdoc
parent2ae9f3729cfda0451a24a8a112fd326170e1cc14 (diff)
downloadqttools-0ea13138a8b8ad324c5bdf2a566fe949766713ef.tar.gz
qdoc: Allow wildcards for excludefiles qdocconf variable
This commit allows the use of simple wildcards ('*' and '?') for excluding a set of files. A typical use case is to exclude all private header files with '*_p.h'. Task-number: QTBUG-50600 Change-Id: Ib50e9e85731d7506ea7299016f609e48ab3d277f Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
Diffstat (limited to 'src/qdoc/doc/qdoc-manual-qdocconf.qdoc')
-rw-r--r--src/qdoc/doc/qdoc-manual-qdocconf.qdoc11
1 files changed, 9 insertions, 2 deletions
diff --git a/src/qdoc/doc/qdoc-manual-qdocconf.qdoc b/src/qdoc/doc/qdoc-manual-qdocconf.qdoc
index 7579a5598..bb4d9af47 100644
--- a/src/qdoc/doc/qdoc-manual-qdocconf.qdoc
+++ b/src/qdoc/doc/qdoc-manual-qdocconf.qdoc
@@ -410,8 +410,15 @@
\endcode
If you include the above in your qdocconf file for qtbase, there
- will be no qwidget.html generated for html and no qwidget.xml
- generated for DITA XML.
+ will be no class documentation generated for QWidget.
+
+ Since Qt 5.6, also simple wildcards ('*' and '?') are recognized by
+ \c excludefiles. For example, to exclude all private Qt header files
+ from being parsed, define the following:
+
+ \badcode
+ excludefiles += "*_p.h"
+ \endcode
See also \l {excludedirs-variable} {excludedirs}.