diff options
author | Kai Köhne <kai.koehne@qt.io> | 2022-08-22 10:23:54 +0200 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-08-22 18:33:09 +0000 |
commit | 9735a4860ecdba03b89dfe21bc3ceca77a9cc532 (patch) | |
tree | 1a25d095f03b3da8b9b1081d267e57fdc51d58fa | |
parent | a7d815027ff72158f56d1e7762515d7edb3a93d2 (diff) | |
download | qttools-9735a4860ecdba03b89dfe21bc3ceca77a9cc532.tar.gz |
Doc: Don't mention qdoc's cpp.ignoredirectives, cpp.ignoretokens anymore
The settings are noops since the switch to clang backend.
Task-number: QTBUG-104903
Change-Id: I09b62c242e8d6fd8613916e33df786da313e6634
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Sona Kurazyan <sona.kurazyan@qt.io>
(cherry picked from commit e69aa186087ff15cb765f0f7604b07ffe7fdb4e2)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r-- | src/qdoc/doc/qdoc-manual-qdocconf.qdoc | 117 | ||||
-rw-r--r-- | src/qdoc/doc/qdoc-manual.qdoc | 1 |
2 files changed, 2 insertions, 116 deletions
diff --git a/src/qdoc/doc/qdoc-manual-qdocconf.qdoc b/src/qdoc/doc/qdoc-manual-qdocconf.qdoc index 8be23cd48..3c21c358b 100644 --- a/src/qdoc/doc/qdoc-manual-qdocconf.qdoc +++ b/src/qdoc/doc/qdoc-manual-qdocconf.qdoc @@ -141,8 +141,6 @@ \list \li \l {alias-variable} {alias} - \li \l {Cpp.ignoredirectives-variable} {Cpp.ignoredirectives} - \li \l {Cpp.ignoretokens-variable} {Cpp.ignoretokens} \li \l {defines-variable} {defines} \li \l {depends-variable} {depends} \li \l {exampledirs-variable} {exampledirs} @@ -193,7 +191,6 @@ \list \li \l {Generic Configuration Variables} - \li \l {C++ Specific Configuration Variables} \li \l {Format-specific Configuration Variables} \endlist @@ -1524,7 +1521,7 @@ /*! \page 22-creating-help-project-files.html \previouspage Generic Configuration Variables - \nextpage C++ Specific Configuration Variables + \nextpage Format-specific Configuration Variables \title Creating Help Project Files @@ -1651,118 +1648,8 @@ */ /*! - \page 23-qdoc-configuration-cppvariables.html - \previouspage Creating Help Project Files - \nextpage Format-specific Configuration Variables - - \title C++ Specific Configuration Variables - - The C++ specific configuration variables are provided to avoid - erroneous documentation due to non-standard C++ constructs. - - \target Cpp.ignoredirectives-variable - \section1 Cpp.ignoredirectives - The \c Cpp.ignoredirectives variable makes QDoc ignore the - specified non-standard constructs, within C++ source code. - - If not specified by the \tt {\l Cpp.ignoretokens} or \tt {\l - Cpp.ignoredirectives} variables, non-standard constructs - (typically macros) can result in erroneous documentation. - - \badcode - Cpp.ignoredirectives = Q_DECLARE_INTERFACE \ - Q_DECLARE_OPERATORS_FOR_FLAGS \ - Q_DECLARE_PRIVATE \ - Q_DECLARE_PUBLIC \ - Q_DISABLE_COPY \ - Q_DUMMY_COMPARISON_OPERATOR \ - Q_ENUMS \ - Q_FLAGS \ - Q_INTERFACES \ - __attribute__ - \endcode - - makes sure that when processing the code below, for example, QDoc - will simply ignore the 'Q_ENUMS' and 'Q_FLAGS' expressions: - - \code - class Q_CORE_EXPORT Qt { - Q_OBJECT - Q_ENUMS(Orientation TextFormat BackgroundMode - DateFormat ScrollBarPolicy FocusPolicy - ContextMenuPolicy CaseSensitivity - LayoutDirection ArrowType) - Q_ENUMS(ToolButtonStyle) - Q_FLAGS(Alignment) - Q_FLAGS(Orientations) - Q_FLAGS(DockWidgetAreas) - - public: - ... - }; - \endcode - - The Q_OBJECT macro, however, is an exception: QDoc recognizes this - particular non-standard construct, so there is no need specifying - it using the \tt {\l Cpp.ignoredirectives} variable. - - Regarding the Q_CORE_EXPORT macro; see the documentation of the - \tt {\l Cpp.ignoretokens} variable. - - See also \l Cpp.ignoretokens. - - \target Cpp.ignoretokens-variable - \section1 Cpp.ignoretokens - - The \c Cpp.ignoretokens variable makes QDoc ignore the specified - non-standard constructs, within C++ source code. - - If not specified by the \tt {\l Cpp.ignoretokens} or \tt {\l - Cpp.ignoredirectives} variables, non-standard constructs - (typically macros) can result in erroneous documentation. - - In \l qtgui.qdocconf: - - \badcode - Cpp.ignoretokens = QAXFACTORY_EXPORT \ - QM_EXPORT_CANVAS \ - ... - Q_COMPAT_EXPORT \ - Q_CORE_EXPORT \ - Q_EXPLICIT \ - Q_EXPORT \ - ... - Q_XML_EXPORT - \endcode - - makes sure that when processing the code below, for example, QDoc - will simply ignore the 'Q_CORE_EXPORT' expression: - - \code - class Q_CORE_EXPORT Qt { - Q_OBJECT - Q_ENUMS(Orientation TextFormat BackgroundMode - DateFormat ScrollBarPolicy FocusPolicy - ContextMenuPolicy CaseSensitivity - LayoutDirection ArrowType) - Q_ENUMS(ToolButtonStyle) - Q_FLAGS(Alignment) - Q_FLAGS(Orientations) - Q_FLAGS(DockWidgetAreas) - public: - ... - }; - \endcode - - Regarding the Q_OBJECT, Q_ENUMS and Q_FLAGS macros; see the - documentation of the \tt {\l Cpp.ignoredirectives} variable. - - See also \l Cpp.ignoredirectives. -*/ - -/*! \page 24-qdoc-configuration-htmlvariables.html - \previouspage C++ Specific Configuration Variables + \previouspage Creating Help Project Files \nextpage Supporting Derived Projects \keyword HTML Specific Configuration Variables diff --git a/src/qdoc/doc/qdoc-manual.qdoc b/src/qdoc/doc/qdoc-manual.qdoc index c66336a83..898324439 100644 --- a/src/qdoc/doc/qdoc-manual.qdoc +++ b/src/qdoc/doc/qdoc-manual.qdoc @@ -37,7 +37,6 @@ \list \li \l {Generic Configuration Variables} \li \l {Creating Help Project Files} - \li \l {C++ Specific Configuration Variables} \li \l {Format-specific Configuration Variables} \li \l {Supporting Derived Projects} \li \l {Example Manifest Files} |