diff options
author | Paul Wicking <paul.wicking@qt.io> | 2021-06-21 14:22:12 +0200 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-06-24 08:25:50 +0000 |
commit | 10ea3dddd159fe095a4d9ef28ced6c83022d11fe (patch) | |
tree | deb7a80704a38bba9697d0e9903679e8ddab5344 | |
parent | 0fd4f2a8def276aab0cb6465ba7b9ce75beb3a86 (diff) | |
download | qttools-10ea3dddd159fe095a4d9ef28ced6c83022d11fe.tar.gz |
Doc: Remove mention of custom filters
Fixes: QTBUG-91082
Change-Id: I5610667072b618d8d0597e618f872266e4397536
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
(cherry picked from commit 235bbe3f939ce4b44b844ec67389c8a71ceceea5)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r-- | src/assistant/help/doc/src/qthelp.qdoc | 46 |
1 files changed, 6 insertions, 40 deletions
diff --git a/src/assistant/help/doc/src/qthelp.qdoc b/src/assistant/help/doc/src/qthelp.qdoc index 9b02c9612..0734d62a8 100644 --- a/src/assistant/help/doc/src/qthelp.qdoc +++ b/src/assistant/help/doc/src/qthelp.qdoc @@ -128,7 +128,7 @@ \li .qhc \li The help collection file that QHelpEngine operates on. It can contain references to any number of compressed help files as - well as additional information, such as custom filters. + well as additional information. \endtable \section1 Generating Qt Help @@ -275,48 +275,14 @@ The virtual folder tag is mandatory and the folder name must not contain any slashes (/). - \target Custom Filters - \section2 Custom Filters - - The Qt help project file contains optional definitions of - custom filters. A custom filter contains a list of filter - attributes which will be used later to display only the documentation - set that has all those attributes assigned. So, when setting the - current filter in the QHelpEngine to \e {My Application 1.0} only - the documentation which has \e myapp and \e {1.0} set as filter - attributes will be shown. - - \snippet doc_src_qthelp.qdoc 9 - - You can define any number of custom filters in a help project file. - It is important to know that you do not have to specify the filter - attributes in the same project file. These attributes can be defined - in any help file, in a filter section. - \target Filter Section \section2 Filter Section - A filter section contains the actual documentation. One Qt help project - file may contain more than one filter sections. Every filter section - consists of four parts, the filter attributes section, the table of - contents, the keywords and the files list. In theory all parts are - optional but not specifying anything there will result in an empty - documentation set. - - \section3 Filter Attributes - - Every filter section should have filter attributes assigned to it, to - enable documentation filtering. If no filter attribute is defined, the - documentation will only be shown if no filtering occurs, meaning the - current custom filter in the QHelpEngine does not contain any filter - attributes. - - \snippet doc_src_qthelp.qdoc 10 - - In this case, the filter attributes \e myapp and \e {1.0} are assigned to - the filter section. This means that all contents specified in this section - will only be shown if the current custom filter has \e myapp or \e {1.0}, - or both, as filter attributes. + A filter section contains the actual documentation. A Qt help project + file may contain more than one filter section. Every filter section + consists of the table of contents, the keywords, and the files list. + In theory all parts are optional but not specifying anything there will + result in an empty documentation set. \section3 Table of Contents |