AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1fbd8c282e
qt5base-lts/doc/global/qt-cpp-defines.qdocconf

235 lines
10 KiB
Plaintext
Raw Normal View History

Doc: Fixed QDoc's navigation mechanism. The HTML pages need to display minimal navigation such as a link to the module landing page or Qt 5's index.html. -new variables available in qdocconf files: navigation.landingpage navigation.homepage navigation.cppclassespage navigation.qmltypespage buildversion The navigation variables are for the new navigation bar. The buildversion variable is to insert documentation build information into the pages. Note about compatibility with Qt Creator docs: The HTML template files for Qt Creator is retained to keep Qt Creator compatible with 5.0.x and 5.1.x. Change-Id: Ibb4d7cada19644204457d822b6b77b2aa7b70f8d Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2013-02-19 16:54:54 +00:00
versionsym = QT_VERSION_STR
Drop Qt3 support QDoc does not need those defines anymore because there is no Qt3Support library anymore; they are simply not #ifdef guarding any code anymore. Task-number: QTBUG-98650 Change-Id: I42b9c3ce025f639ce6282102b5eadb52fea7fa8e Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-11-25 19:12:40 +00:00
defines += Q_QDOC \
qdoc: Add config variable for clang defines The qdoc 'defines' config variable lists values that contain '*' to represent wildcards, but clang doesn't accept them. This change adds a new config variable called 'clangdefines' which explicitly lists all the defines that match the wildcards. It also lists several Qt defines for C++11 stuff, because when clangqdoc comes into use, all the supported compilers for Qt will support C++11 constructs. There might be a few defines listed in clangdefines that are unnecessary and maybe a few that we really should not include, but we can adjust the list as needed. The clangqdoc code that reads this new config variable will be added in a separate change. This change will not affect the non-clang qdoc, because qdoc will just ignore the clangdefines variable. This change also adds Q_CLANG_QDOC to 'defines' and to 'clangdefine'. Q_CLANG_QDOC is meant to be used in the sources the way Q_QDOC is used. It indicates that a particular use of Q_QDOC has been reviewed and is still required for clangqdoc. Change-Id: I3b00b18ec726196eda5cfa8411cd3e87433fec59 Reviewed-by: Martin Smith <martin.smith@qt.io>
2016-08-12 10:30:43 +00:00
Q_CLANG_QDOC \
Doc: Fixed QDoc's navigation mechanism. The HTML pages need to display minimal navigation such as a link to the module landing page or Qt 5's index.html. -new variables available in qdocconf files: navigation.landingpage navigation.homepage navigation.cppclassespage navigation.qmltypespage buildversion The navigation variables are for the new navigation bar. The buildversion variable is to insert documentation build information into the pages. Note about compatibility with Qt Creator docs: The HTML template files for Qt Creator is retained to keep Qt Creator compatible with 5.0.x and 5.1.x. Change-Id: Ibb4d7cada19644204457d822b6b77b2aa7b70f8d Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2013-02-19 16:54:54 +00:00
QT_.*_SUPPORT \
QT_.*_LIB \
QT_COMPAT \
QT_KEYPAD_NAVIGATION \
QT_NO_EGL \
Q_BYTE_ORDER \
QT_DEPRECATED \
QT_DEPRECATED_* \
Q_NO_USING_KEYWORD \
qdoc: Reintroduce Q_OS_* defines into the global documentation config This was dropped by commit 740ff1b8 in preparation for clang-based C++ parser in qdoc. However, the old (current) parser still needs it, as some of the functions to document are wrapped with those macros. It does not interfere with the clang parser anyway; unlike the old parser, clang will not resolve the wildcards in macros. Change-Id: I3135a263e8eb200a11b1e918c776e3a2c3ec5fb6 Reviewed-by: Martin Smith <martin.smith@qt.io>
2017-04-27 12:05:23 +00:00
Q_OS_.* \
qdoc: Enable support for rvalue references in function signatures qdoc interprets the double-ampersand in function parameters using rvalue references (e.g. 'Type &&other') incorrectly as a logical AND operator, resulting in a syntax error. This change works around the issue by treating '&' the same as '*', and defining Q_COMPILER_RVALUE_REFS for qdoc. Task-number: QTBUG-32675 Change-Id: I499611f16f22c33ff5b878da0cd59d67ddf53d72 Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-29 07:10:52 +00:00
Q_COMPILER_INITIALIZER_LISTS \
qcompilerdetection.h: add Q_COMPILER_UNIFORM_INIT Up to now, the feature classe Uniform Initialization was subsumed by the Q_COMPILER_INITIALIZER_LISTS flag together with support for std::initializer_list. This caused at least two problems: 1. On QNX, the standard libray does not ship <initializer_list>, even though the compiler (a GCC 4.6, IIRC) supports it. But since there was only one Q_COMPILER flag for both, support for the compiler-only part of the feature had to be disabled, too. 2. MSVC 2013 supports initializer lists, but has a bug that renders full uniform initialization support, as required for QUuid, useless. By splitting the feature into two, we can separate them better, and do so in QUuid, which is the only class that currently takes advantage of uniform initialization (to provide constexpr constructors). Since Q_COMPILER_INITIALIZER_LISTS worked as a flag for uniform initialization so far, with the two known exceptions above, UNIFORM_INIT is defined whenever INITIALIZER_LIST is, except that I don't revert UNIFORM_INIT on QNX as I do for INITIALIZER_LISTS and that I expect the MSVC 2013 features to set INITIALIZER_LIST, but not UNIFORM_INIT. Task-number: QTBUG-34705 Change-Id: I81916e950a0f3aab3de7977e0326d2de3d31b14c Reviewed-by: Yuchen Deng <loaden@gmail.com> Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
2013-11-12 10:17:05 +00:00
Q_COMPILER_UNIFORM_INIT \
qdoc: Enable support for rvalue references in function signatures qdoc interprets the double-ampersand in function parameters using rvalue references (e.g. 'Type &&other') incorrectly as a logical AND operator, resulting in a syntax error. This change works around the issue by treating '&' the same as '*', and defining Q_COMPILER_RVALUE_REFS for qdoc. Task-number: QTBUG-32675 Change-Id: I499611f16f22c33ff5b878da0cd59d67ddf53d72 Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-29 07:10:52 +00:00
Q_COMPILER_RVALUE_REFS
Doc: Fixed QDoc's navigation mechanism. The HTML pages need to display minimal navigation such as a link to the module landing page or Qt 5's index.html. -new variables available in qdocconf files: navigation.landingpage navigation.homepage navigation.cppclassespage navigation.qmltypespage buildversion The navigation variables are for the new navigation bar. The buildversion variable is to insert documentation build information into the pages. Note about compatibility with Qt Creator docs: The HTML template files for Qt Creator is retained to keep Qt Creator compatible with 5.0.x and 5.1.x. Change-Id: Ibb4d7cada19644204457d822b6b77b2aa7b70f8d Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2013-02-19 16:54:54 +00:00
qdoc: Remove __cplusplus from the defines list __cplusplus was removed from the list of defines passed to qdoc because it should not be there for clang-qdoc. Change-Id: I32802e68d915f7a5b717f16ba26a1cd57d7ff645 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2018-01-31 12:18:25 +00:00
clangdefines += Q_QDOC \
qdoc: Add config variable for clang defines The qdoc 'defines' config variable lists values that contain '*' to represent wildcards, but clang doesn't accept them. This change adds a new config variable called 'clangdefines' which explicitly lists all the defines that match the wildcards. It also lists several Qt defines for C++11 stuff, because when clangqdoc comes into use, all the supported compilers for Qt will support C++11 constructs. There might be a few defines listed in clangdefines that are unnecessary and maybe a few that we really should not include, but we can adjust the list as needed. The clangqdoc code that reads this new config variable will be added in a separate change. This change will not affect the non-clang qdoc, because qdoc will just ignore the clangdefines variable. This change also adds Q_CLANG_QDOC to 'defines' and to 'clangdefine'. Q_CLANG_QDOC is meant to be used in the sources the way Q_QDOC is used. It indicates that a particular use of Q_QDOC has been reviewed and is still required for clangqdoc. Change-Id: I3b00b18ec726196eda5cfa8411cd3e87433fec59 Reviewed-by: Martin Smith <martin.smith@qt.io>
2016-08-12 10:30:43 +00:00
Q_CLANG_QDOC \
QT_COMPAT \
QT_BUILD_CORE_LIB \
QT_BUILD_EGL_DEVICE_LIB \
QT_BUILD_LOCATION_LIB \
QT_BUILD_SCRIPT_LIB \
QT_BUILD_TESTLIB_LIB \
QT_BUILD_WIDGETS_LIB \
QT_CORE_LIB \
QT_DEPRECATED \
QT_GUI_LIB \
QT_KEYPAD_NAVIGATION \
QT_LARGEFILE_SUPPORT \
QT_NETWORK_LIB \
QT_NO_EGL \
QT_OPENGL_SUPPORT \
QT_SCRIPT_LIB \
QT_SHARED_POINTER_BACKTRACE_SUPPORT \
QT_WIDGETS_LIB \
Q_BYTE_ORDER \
Q_CC_CLANG \
Q_COMPILER_CONSTEXPR \
Q_COMPILER_DEFAULT_MEMBERS \
Q_COMPILER_DELETE_MEMBERS \
Q_COMPILER_EXPLICIT_OVERRIDES \
Q_COMPILER_INITIALIZER_LISTS \
Q_COMPILER_MANGLES_RETURN_TYPE \
Q_COMPILER_NOEXCEPT \
Q_COMPILER_NULLPTR \
Q_COMPILER_RVALUE_REFS \
Q_COMPILER_STATIC_ASSERT \
Q_COMPILER_UNIFORM_INIT \
Q_COMPILER_VARIADIC_MACROS \
Q_COMPILER_VARIADIC_TEMPLATES \
Q_ATOMIC_INT16_IS_SUPPORTED \
Q_ATOMIC_INT64_IS_SUPPORTED \
Drop Qt4 support Last pieces of code guarded by these defined were cleaned up back in 2016. Task-number: QTBUG-98650 Change-Id: I52d971c2b476b7d8d362be7807b71b71e657c70b Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
2021-11-25 19:12:40 +00:00
Q_ATOMIC_INT8_IS_SUPPORTED
qdoc: Add config variable for clang defines The qdoc 'defines' config variable lists values that contain '*' to represent wildcards, but clang doesn't accept them. This change adds a new config variable called 'clangdefines' which explicitly lists all the defines that match the wildcards. It also lists several Qt defines for C++11 stuff, because when clangqdoc comes into use, all the supported compilers for Qt will support C++11 constructs. There might be a few defines listed in clangdefines that are unnecessary and maybe a few that we really should not include, but we can adjust the list as needed. The clangqdoc code that reads this new config variable will be added in a separate change. This change will not affect the non-clang qdoc, because qdoc will just ignore the clangdefines variable. This change also adds Q_CLANG_QDOC to 'defines' and to 'clangdefine'. Q_CLANG_QDOC is meant to be used in the sources the way Q_QDOC is used. It indicates that a particular use of Q_QDOC has been reviewed and is still required for clangqdoc. Change-Id: I3b00b18ec726196eda5cfa8411cd3e87433fec59 Reviewed-by: Martin Smith <martin.smith@qt.io>
2016-08-12 10:30:43 +00:00
# Q_COMPILER_REF_QUALIFIERS is not yet supported by all compilers
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
Cpp.ignoretokens += \
Doc: Adding Enginio's export macro to the list of excluded QDoc tokens. -helps the QDoc parser read C++ API when the macro is excluded. Task-number: QTBUG-33360 Change-Id: Ic7e86c0d1cec4a1960d20b1c92c4b60396eb3ea6 Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2014-04-14 12:12:00 +00:00
ENGINIOCLIENT_EXPORT \
Doc: Integrated ignoretokens and ignoredirectives from Qt Multimedia. Sorted the entries Change-Id: I6e1716c899e2f7e5360571ccfbde5aaf798d65af Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-07 11:38:47 +00:00
PHONON_EXPORT \
qdoc: Ignore Q_ALWAYS_INLINE and QT_HAS_INCLUDE() Number of API changes in Qt 5.8 use these macros and QDoc needs to ignore them the correctly match the documentation to the function signatures. Task-number: QTBUG-57424 Change-Id: I0c3a0eb4deb2d9b348f24800591bc6f6b47cf458 Reviewed-by: Martin Smith <martin.smith@qt.io> Reviewed-by: Marc Mutz <marc.mutz@kdab.com>
2016-12-02 08:51:52 +00:00
Q_ALWAYS_INLINE \
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
Q_AUTOTEST_EXPORT \
Q_BLUETOOTH_EXPORT \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
Q_COMPAT_EXPORT \
Q_CORE_EXPORT \
Q_CORE_EXPORT_INLINE \
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
Q_DBUS_EXPORT \
Q_DECL_CONSTEXPR \
Add Q_DECL_RELAXED_CONSTEXPR macro Expands to constexpr if C++14 relaxed constepxr are supported by the compiler [ChangeLog][QtCore] Added Q_DECL_RELAXED_CONSTEXPR for the corresponding C++14 feature Change-Id: Id6b56b3a17da2ff838c80795e528e1247dc13f63 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
2014-08-23 16:26:01 +00:00
Q_DECL_RELAXED_CONSTEXPR \
Introduce Q_DECL_CONST_FUNCTION and Q_DECL_PURE_FUNCTION That expand to __attribute__((const)) and ((pure)). A "const" function is a function allowed to examine only its arguments, without modifying them. A "pure" function is also allowed to read memory. Currently working only on GCC/ICC/Clang, MSVC lacks these. Change-Id: Ie60a0847b193fb88e116f61611dc571296a3df1c Reviewed-by: Marc Mutz <marc.mutz@kdab.com>
2014-03-01 13:12:33 +00:00
Q_DECL_CONST_FUNCTION \
Make qdoc ignore the Q_DECL_DEPRECATED token Task-number: QTBUG-27829 Change-Id: Ic3d25cd7da2a2c1266dfa113b7138f4086215777 Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-09-14 18:36:38 +00:00
Q_DECL_DEPRECATED \
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
Q_DECL_NOEXCEPT \
qdoc: Links to Q_DECL_FINAL not created This update fixes part of QTBUG-37719. Q_DECL_FINAL is a macro that is documented, but links to the documentation for it were not created. The problem was that Q_DECL_FINAL is actually used in the Qt sources, but it was not listed in the Cpp.ignoretokens clause in the qdocconf file. This update just adds it to Cpp.ignoretokens. Task-number: QTBUG-37719 Change-Id: I62945df4976b21b67084e6de25e25bbc4c92f89f Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-04-08 12:09:12 +00:00
Q_DECL_FINAL \
qdoc: ignore Q_DECL_OVERRIDE Change-Id: Idf07753b6811c1ec8dba1ddd0fbb8036ce6723f2 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
2014-11-22 10:47:46 +00:00
Q_DECL_OVERRIDE \
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
Q_DECL_NOTHROW \
Introduce Q_DECL_CONST_FUNCTION and Q_DECL_PURE_FUNCTION That expand to __attribute__((const)) and ((pure)). A "const" function is a function allowed to examine only its arguments, without modifying them. A "pure" function is also allowed to read memory. Currently working only on GCC/ICC/Clang, MSVC lacks these. Change-Id: Ie60a0847b193fb88e116f61611dc571296a3df1c Reviewed-by: Marc Mutz <marc.mutz@kdab.com>
2014-03-01 13:12:33 +00:00
Q_DECL_PURE_FUNCTION \
Ask qdoc not to parse Q_DECL_UNUSED We have it on function declarations and it gets a bit lost... Change-Id: I19ba2e760f3714c26e78c3d8fd2570af3dcd136e Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>
2014-01-09 23:16:49 +00:00
Q_DECL_UNUSED \
qdoc: Missing names from ignored tokens list Q_DECL_CF_RETURNS_RETAINED and Q_DECL_NS_RETURNS_AUTORELEASED are added to qdoc's list of ignored tokens. Without them, qdoc fails to parse a few function declarations. Change-Id: If59066a765882d88881eed7db31b4b52a6e570ea Task-number: QTBUG-46920 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2015-06-29 12:18:12 +00:00
Q_DECL_CF_RETURNS_RETAINED \
Q_DECL_NS_RETURNS_AUTORELEASED \
Ignore Q_SERIALBUS_EXPORT and Q_DECL_EQ_DEFAULT in qdoc Change-Id: I3ec9170aba408e8c01c7940f2537a017dbeae065 Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
2015-11-26 11:53:33 +00:00
Q_DECL_EQ_DEFAULT \
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
Q_DECLARATIVE_EXPORT \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
Q_EXPLICIT \
Q_EXPORT \
Q_EXPORT_PLUGIN \
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
Q_EXPORT_PLUGIN2 \
Q_GADGET \
Long live Q_GADGET_EXPORT! Like Q_NAMESPACE_EXPORT for Q_NAMESPACE, this variant of Q_GADGET allows passing an export macro. This is useful to avoid exporting the whole class just to get the staticMetaObject hidden therein exported. Before anyone asks: No, we don't need Q_OBJECT_EXPORT, because QObject subclasses, being polymorphic, always need to have a class-level export macro (to export their vtable), but while that technique also works for value classes (the Q_GADGET audience), it is not desirable for them, because it makes inline functions exported in Windows debug builds, which is not what we want, because it needlessly restricts what you can to with the inline functions (e.g. remove). [ChangeLog][QtCore] Added the Q_GADGET_EXPORT macro, which is like Q_GADGET, but allows passing an export macro (like Q_NAMESPACE_EXPORT for Q_NAMESPACE). Fixes: QTBUG-55458 Change-Id: I546297de1e8aa45d83381991bcd3fbca61e1eef0 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
2021-11-22 09:30:04 +00:00
Q_GADGET_EXPORT \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
Q_GFX_INLINE \
Q_GUI_EXPORT \
Q_GUI_EXPORT_INLINE \
Q_GUI_EXPORT_STYLE_CDE \
Q_GUI_EXPORT_STYLE_COMPACT \
Q_GUI_EXPORT_STYLE_MAC \
Q_GUI_EXPORT_STYLE_MOTIF \
Q_GUI_EXPORT_STYLE_MOTIFPLUS \
Q_GUI_EXPORT_STYLE_PLATINUM \
Q_GUI_EXPORT_STYLE_POCKETPC \
Q_GUI_EXPORT_STYLE_SGI \
Q_GUI_EXPORT_STYLE_WINDOWS \
Q_INLINE_TEMPLATE \
Q_INTERNAL_WIN_NO_THROW \
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
Q_INVOKABLE \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
Q_LOCATION_EXPORT \
Add qdoc ignore tag for new QtPositioning API. Change-Id: If725ac4e523d56a8dc274f8d6b53c0c34064ca06 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-08-22 10:39:32 +00:00
Q_POSITIONING_EXPORT \
Doc: Placed missing '\' Change-Id: I311ea81e2cdd0069f2a93758c3cd38bc75ae0b54 Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-07 11:53:07 +00:00
Q_MULTIMEDIA_EXPORT \
Say hello to Q_NAMESPACE Q_NAMESPACE is useful to add Q_ENUM_NS/Q_ENUMS, Q_FLAG_NS/Q_FLAGS and Q_CLASSINFO to a namespace. [ChangeLog] Added Q_NAMESPACE which can be used to add Q_ENUM_NS/ Q_ENUMS, Q_FLAG_NS/Q_FLAGS and Q_CLASSINFO to a namespace Task-number: QTBUG-54981 Change-Id: Ic61b972794063e77134681fb347d6c4acddcdb44 Reviewed-by: Olivier Goffart (Woboq GmbH) <ogoffart@woboq.com>
2016-08-19 12:44:42 +00:00
Q_NAMESPACE \
Introduce Q_NAMESPACE_EXPORT A recurring problem with the Q_NAMESPACE macro is that it declares an object (staticMetaObject) in the surrounding namespace. That object lacks any export/import qualification to make it usable with shared libraries. Introduce therefore another macro to work around this issue, allowing the user to prefix the object with an exporting macro, f.i. like this: Q_NAMESPACE_EXPORT(Q_CORE_EXPORT) The old macro can simply then be rewritten in terms of this new one, supplying an empty export macro. Note that NOT passing an argument to a macro expecting one is well defined behavior in C99 -- the macro will expand an empty token. Of course, MSVC doesn't like this and emits warnings. As a workaround, use a variadic macro. [ChangeLog][QtCore] Added the new Q_NAMESPACE_EXPORT macro. It can be used just like Q_NAMESPACE to add meta-object information to a namespace; however it also supports exporting of such information from shared libraries. [ChangeLog][Potentially Source-Incompatible Changes] Prefixing Q_NAMESPACE with an export macro may no longer work. Use the new Q_NAMESPACE_EXPORT macro for that use case. Fixes: QTBUG-68014 Change-Id: Ib044a555ace1f77ae8e0244d824ec473550f3d8e Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: BogDan Vatra <bogdan@kdab.com>
2019-04-30 07:39:21 +00:00
Q_NAMESPACE_EXPORT \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
Q_NETWORK_EXPORT \
doc: Added Q_NEVER_INLINE to ignored tokens This helps qdoc's parser. Change-Id: I4c7f2dff348b87659c93ddb14d012d5bf2e626f2 Task-number: QTBUG-46498 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-06-05 09:35:01 +00:00
Q_NEVER_INLINE \
Doc: ignore "Q_NORETURN" in function signatures. Needed by the upcoming function Q_NORETURN void QCommandLineParser::showHelp(int exitCode) Change-Id: Ie8550d2d0eff9eb20e629eef4952fa2b0b10f873 Reviewed-by: Laszlo Papp <lpapp@kde.org> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>
2013-08-09 20:35:09 +00:00
Q_NORETURN \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
Q_OPENGL_EXPORT \
Q_OPENVG_EXPORT \
Q_OUTOFLINE_TEMPLATE \
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
Q_PRINTSUPPORT_EXPORT \
qdoc: Added missing CPP ignore token, Q_QML_EXPORT This token must be ignored by qdoc's hapless C++ parser. Task-number: QTBUG-29444 Change-Id: I02a0c5926a3fa6284648a632341e38614a237a30 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-04-03 11:25:26 +00:00
Q_QML_EXPORT \
doc: Added Q_REQUIRED_RESULT to ignored tokens This macro is apparently knew. It was unknown to qdoc. Now qdoc knows to ignore it. Task-number: QTBUG-32344 Change-Id: Id4455ad2329aeb2d2f8cacef99cdd1ff2a72321c Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-07-19 10:37:03 +00:00
Q_REQUIRED_RESULT \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
Q_SCRIPT_EXPORT \
Q_SCRIPTTOOLS_EXPORT \
Ignore Q_SERIALBUS_EXPORT and Q_DECL_EQ_DEFAULT in qdoc Change-Id: I3ec9170aba408e8c01c7940f2537a017dbeae065 Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
2015-11-26 11:53:33 +00:00
Q_SERIALBUS_EXPORT \
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
Q_SQL_EXPORT \
Q_SVG_EXPORT \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
Q_TESTLIB_EXPORT \
Doc: Integrated ignoretokens and ignoredirectives from Qt Multimedia. Sorted the entries Change-Id: I6e1716c899e2f7e5360571ccfbde5aaf798d65af Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-07 11:38:47 +00:00
Q_TYPENAME \
QString: add char8_t overload of fromUtf8() Use the overload-with-template trick from P1423 to avoid ambiguities when existing callers pass 0 or nullptr. Add a qdoc-ignored macro to hide the fact that the overload is a template. [ChangeLog][QtCore][QString] Added char8_t overload of fromUtf8(). Change-Id: Iaa2d365bfa161ef36cc73fa3bad50aabf34d01db Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
2020-06-22 09:44:34 +00:00
Q_WEAK_OVERLOAD \
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
Q_WIDGETS_EXPORT \
qdoc: ignore Q_WINEXTRAS_EXPORT This is required for functions in the QtWin namespace. Change-Id: I6c38c8ef262377050a75861435da381863340f33 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-10-02 10:14:17 +00:00
Q_WINEXTRAS_EXPORT \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
Q_XML_EXPORT \
Q_XMLPATTERNS_EXPORT \
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
Q_XMLSTREAM_EXPORT \
QAXFACTORY_EXPORT \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
QDBUS_EXPORT \
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
QDESIGNER_COMPONENTS_LIBRARY \
QDESIGNER_EXTENSION_LIBRARY \
QDESIGNER_SDK_LIBRARY \
QDESIGNER_SHARED_LIBRARY \
QDESIGNER_UILIB_LIBRARY \
QHELP_EXPORT \
Doc: Integrated ignoretokens and ignoredirectives from Qt Multimedia. Sorted the entries Change-Id: I6e1716c899e2f7e5360571ccfbde5aaf798d65af Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-07 11:38:47 +00:00
QM_AUTOTEST_EXPORT \
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
QM_EXPORT_CANVAS \
QM_EXPORT_DNS \
QM_EXPORT_DOM \
QM_EXPORT_FTP \
QM_EXPORT_HTTP \
QM_EXPORT_ICONVIEW \
QM_EXPORT_NETWORK \
QM_EXPORT_OPENGL \
QM_EXPORT_OPENVG \
QM_EXPORT_SQL \
QM_EXPORT_TABLE \
QM_EXPORT_WORKSPACE \
QM_EXPORT_XML \
QT_ASCII_CAST_WARN \
QT_ASCII_CAST_WARN_CONSTRUCTOR \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
QT_BEGIN_INCLUDE_NAMESPACE \
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
QT_BEGIN_NAMESPACE \
QT_BOOTSTRAPPED \
QT_DESIGNER_STATIC \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
QT_END_INCLUDE_NAMESPACE \
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
QT_END_NAMESPACE \
QT_FASTCALL \
qdoc: Ignore QT_MUTEX_LOCK_NOEXCEPT macros QT_MUTEX_LOCK_NOEXCEPT is defined as Q_DECL_NOTHROW on Linux, the latter being already ignored by qdoc. This change ignores also the former, clearing related documentation warnings. Change-Id: Iaeee7a851b4b6d3c2e3308c1b376406c11271807 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-09-05 07:36:02 +00:00
QT_MUTEX_LOCK_NOEXCEPT \
qdoc: Ignore QT_POPCOUNT_CONSTEXPR token This enables a number of functions declared in the qalgorithms.h to be successfully documented. Change-Id: I20c5827bb8f9e2ada98fd368b7827c5b156a518e Reviewed-by: Martin Smith <martin.smith@qt.io>
2017-04-20 12:35:20 +00:00
QT_POPCOUNT_CONSTEXPR \
Add a marker for post-C++17 APIs in exported classes MSVC will export any function in an exported class, including inline ones. Conversely: client code calling inline functions in imported classes will end up simply calling the symbol of the function, even if the function is fully inline. This is a problem for adding post-C++17 APIs in Qt. Such APIs are added as inline functions protected by feature-macro tests, so that both Qt and client apps can use any C++ version they want (any combination works). However, if we add a function using post-C++17 API to an exported class, then the combination "Qt built in C++17" + "client built in post-C++17" won't work any more. The client will expect the symbol for that function to be exported by Qt, but Qt won't have it (built in C++17). As a workaround, add a marker that turns these functions into "faux templates", like Q_WEAK_OVERLOAD does. Change-Id: I2adab81e3129c881c5a8e0772948b176fa4db1b6 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
2022-04-06 14:39:22 +00:00
QT_POST_CXX17_API_IN_EXPORTED_CLASS \
QSizePolicy: add some constexpr Also add a basic test for constexpr expressions involving QSizePolicy. GCC < 4.8.0 has problems with initializing variant members in constexpr ctors: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=54922 Instead of revoking its Q_COMPILER_CONSTEXPR, which is a source-incompatible change, simply note the fact so we can selectively provide constexpr for QSizePolicy. Change-Id: Iba8e5a7cdf847d73e8e2b6bb6211fb3c9846aa0a Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
2015-01-19 10:29:52 +00:00
QT_SIZEPOLICY_CONSTEXPR \
qdoc: Ignore macro QT_WARNING_DISABLE_DEPRECATED This macro, introduced in Qt 5.8, needs to be ignored by QDoc in order to generate documentation correctly for a number of deprecated functions. Change-Id: I50bcd42167e3fafb7dda88484fde86e1aebb5980 Reviewed-by: Martin Smith <martin.smith@qt.io>
2016-12-14 11:57:28 +00:00
QT_WARNING_DISABLE_DEPRECATED \
Use the new warning enabling/disabling macros in qtbase Change-Id: I91ff06644e8047c2ca483f9768b46c1372eb6171 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@theqtcompany.com>
2014-10-31 05:44:13 +00:00
QT_WARNING_PUSH \
QT_WARNING_POP \
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
QT_WIDGET_PLUGIN_EXPORT \
QWEBKIT_EXPORT
Doc: Fixed QDoc's navigation mechanism. The HTML pages need to display minimal navigation such as a link to the module landing page or Qt 5's index.html. -new variables available in qdocconf files: navigation.landingpage navigation.homepage navigation.cppclassespage navigation.qmltypespage buildversion The navigation variables are for the new navigation bar. The buildversion variable is to insert documentation build information into the pages. Note about compatibility with Qt Creator docs: The HTML template files for Qt Creator is retained to keep Qt Creator compatible with 5.0.x and 5.1.x. Change-Id: Ibb4d7cada19644204457d822b6b77b2aa7b70f8d Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2013-02-19 16:54:54 +00:00
Cpp.ignoredirectives += \
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
__attribute__ \
K_DECLARE_PRIVATE \
Doc: Integrated ignoretokens and ignoredirectives from Qt Multimedia. Sorted the entries Change-Id: I6e1716c899e2f7e5360571ccfbde5aaf798d65af Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-07 11:38:47 +00:00
PHONON_HEIR \
PHONON_OBJECT \
Doc: Placed missing '\' Change-Id: I311ea81e2cdd0069f2a93758c3cd38bc75ae0b54 Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-07 11:53:07 +00:00
Q_CLASSINFO \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
Q_DECLARE_INTERFACE \
Q_DECLARE_METATYPE \
Prevent repeated instantiations of some qRegisterNormalizedMetaType<>s [1/N] (QtGui) Create macros that wrap the magic developed in 7d63efc16f65f98c657caa90e0d7e9b72a879ade and apply it to all Q_DECLARE_METATYPE invocations that show up in Clang -ftime-trace for a PCH'ed QtGui build. Effects on compile times: Clang 10 -ftme-trace: $ ClangBuildAnalyzer --analyze qtgui-before.trace | head -n6 Analyzing build trace from 'qtgui-before.trace'... **** Time summary: Compilation (523 times): Parsing (frontend): 628.3 s Codegen & opts (backend): 304.5 s $ ClangBuildAnalyzer --analyze qtgui-after.trace | head -n6 Analyzing build trace from 'qtgui-after.trace'... **** Time summary: Compilation (523 times): Parsing (frontend): 546.0 s Codegen & opts (backend): 304.4 s GCC 11 time (bash builtin): before: $ time for ((i=0; i < 3; ++i)) do touch src/gui/painting/qpolygon.h ; ninja libQt6Gui.so; done real 4m13,539s user 49m24,416s sys 3m18,177s after: $ time for ((i=0; i < 3; ++i)) do touch src/gui/painting/qpolygon.h ; ninja libQt6Gui.so; done real 3m55,697s user 45m19,941s sys 3m7,370s Task-number: QTBUG-97601 Pick-to: 6.3 Change-Id: Ia8e37a58937568a7ed21cfeb4b27274deca4d53b Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2022-01-18 16:38:48 +00:00
QT_DECL_METATYPE_EXTERN \
QT_IMPL_METATYPE_EXTERN \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
Q_DECLARE_OPERATORS_FOR_FLAGS \
Q_DECLARE_PRIVATE \
Doc: Consolidated the QDoc variables. -Modules only need to include qt-module-defaults.qdocconf -Sorted the variables. -The variables still need to be confirmed to be important. Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:27:25 +00:00
Q_DECLARE_PRIVATE_D \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
Q_DECLARE_PUBLIC \
Q_DECLARE_SHARED \
Q_DECLARE_TR_FUNCTIONS \
Q_DECLARE_TYPEINFO \
Doc: ignore Q_DECL_NOEXCEPT_EXPR and QT_DEPRECATED_X This fixes most of the \fn-not-found errors in QtCore. Change-Id: I61a48646c6341cb3310bbb83f190a15e9225fd14 Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com> Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
2014-03-17 11:55:44 +00:00
Q_DECL_NOEXCEPT_EXPR \
QT_DEPRECATED_X \
Doc: Ignore QT_SYSINFO_DEPRECATED_X QSysInfo has a customized deprecation directive that QDoc needs to ignore to generate documentation for the deprecated functionality. Change-Id: I1c378f14a2f842f1e9a55614d43fe509bb77fd89 Reviewed-by: Marc Mutz <marc.mutz@kdab.com>
2017-03-08 12:21:42 +00:00
QT_SYSINFO_DEPRECATED_X \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
Q_DISABLE_COPY \
Q_DUMMY_COMPARISON_OPERATOR \
qdoc: Let qdoc ignore Q_ENUM and Q_FLAG Q_ENUM and Q_FLAG were not listed in the Cpp.ignoredirectives variable in qt-cpp-defines.qdocconf. This never used to cause parsing errors in qdoc, but now it does. The cause for this change was not determined at the time of this fix, which is to add Q_ENUM and Q_FLAG to the ignore directives list. Change-Id: I717c9101f7706097869f23b53eeca8cb1a0fee0a Task-number: QTBUG-44510 Reviewed-by: Olivier Goffart (Woboq GmbH) <ogoffart@woboq.com>
2015-02-18 13:03:11 +00:00
Q_ENUM \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
Q_ENUMS \
Add Q_[ENUM|FLAG]_NS to global qt-cpp-defines doc conf We need to add Q_[ENUM|FLAG]_NS to global qt-cpp-defines doc conf otherwise qdoc ignores them and it will not produce any documentation or links to these enums/flags Task-number: QTBUG-57616 Change-Id: I744317346feb41db02787677f8698c4de15db226 Reviewed-by: Martin Smith <martin.smith@qt.io>
2016-12-14 13:37:52 +00:00
Q_ENUM_NS \
qdoc: Let qdoc ignore Q_ENUM and Q_FLAG Q_ENUM and Q_FLAG were not listed in the Cpp.ignoredirectives variable in qt-cpp-defines.qdocconf. This never used to cause parsing errors in qdoc, but now it does. The cause for this change was not determined at the time of this fix, which is to add Q_ENUM and Q_FLAG to the ignore directives list. Change-Id: I717c9101f7706097869f23b53eeca8cb1a0fee0a Task-number: QTBUG-44510 Reviewed-by: Olivier Goffart (Woboq GmbH) <ogoffart@woboq.com>
2015-02-18 13:03:11 +00:00
Q_FLAG \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
Q_FLAGS \
Add Q_[ENUM|FLAG]_NS to global qt-cpp-defines doc conf We need to add Q_[ENUM|FLAG]_NS to global qt-cpp-defines doc conf otherwise qdoc ignores them and it will not produce any documentation or links to these enums/flags Task-number: QTBUG-57616 Change-Id: I744317346feb41db02787677f8698c4de15db226 Reviewed-by: Martin Smith <martin.smith@qt.io>
2016-12-14 13:37:52 +00:00
Q_FLAG_NS \
qdoc: Ignore Q_ALWAYS_INLINE and QT_HAS_INCLUDE() Number of API changes in Qt 5.8 use these macros and QDoc needs to ignore them the correctly match the documentation to the function signatures. Task-number: QTBUG-57424 Change-Id: I0c3a0eb4deb2d9b348f24800591bc6f6b47cf458 Reviewed-by: Martin Smith <martin.smith@qt.io> Reviewed-by: Marc Mutz <marc.mutz@kdab.com>
2016-12-02 08:51:52 +00:00
QT_HAS_INCLUDE \
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
Q_INTERFACES \
Q_PRIVATE_PROPERTY \
Doc: Integrated ignoretokens and ignoredirectives from Qt Multimedia. Sorted the entries Change-Id: I6e1716c899e2f7e5360571ccfbde5aaf798d65af Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-07 11:38:47 +00:00
QT_FORWARD_DECLARE_CLASS \
Doc: Added the Q_REVISION macro to the ignore list This should avoid QDoc warnings when the macro is used with the signals and slots. Task-number QTBUG-30105 Change-Id: I8d1b32854c15ff07e6ece7b326be38666ae29c3f Reviewed-by: Shawn Rutledge <shawn.rutledge@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-03-19 15:13:24 +00:00
Q_DECLARE_HANDLE \
Use the new warning enabling/disabling macros in qtbase Change-Id: I91ff06644e8047c2ca483f9768b46c1372eb6171 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@theqtcompany.com>
2014-10-31 05:44:13 +00:00
Q_REVISION \
QT_WARNING_DISABLE_CLANG \
QT_WARNING_DISABLE_GCC \
QT_WARNING_DISABLE_INTEL \
qdoc: Missing name from ignored directives Q_ATTRIBUTE_FORMAT_PRINTF is added to qdoc's list of ignored directives. Without it, qdoc fails to parse a few function declarations. Change-Id: Ie24a58d9a5dcdffb8c103b2f5e34dd09b9471f06 Task-number: QTBUG-46920 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2015-06-29 11:45:04 +00:00
QT_WARNING_DISABLE_MSVC \
Merge remote-tracking branch 'origin/5.5' into dev Conflicts: doc/global/qt-cpp-defines.qdocconf src/3rdparty/forkfd/forkfd.c src/corelib/codecs/qtextcodec.cpp src/corelib/kernel/qmetatype.cpp src/corelib/tools/qset.qdoc src/gui/accessible/qaccessible.cpp src/gui/image/qpixmapcache.cpp src/opengl/qgl.cpp src/tools/qdoc/generator.cpp src/widgets/kernel/qwidget.cpp tests/auto/widgets/widgets/qcombobox/tst_qcombobox.cpp Change-Id: I4fbe1fa756a54c6843aa75f4ef70a1069ba7b085
2015-08-06 08:45:40 +00:00
Q_ATTRIBUTE_FORMAT_PRINTF \
qglobal: add a way to selectively export in Qt 6 XOR Qt 7 Because at least one compiler *cough*MSVC*cough* is unable to dllexport a method that is in a dllexport'ed class. Change-Id: I54f205f6b7314351b078fffd16d06b4e6ef0c086 Reviewed-by: Marc Mutz <marc.mutz@qt.io> Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
2022-02-03 23:44:08 +00:00
Q_MV_IOS \
QT6_ONLY \
QT7_ONLY
Doc: Evaluate QT_VERSION >= QT_VERSION_CHECK(6,0,0) to false This check is used in many places in the public header files, and correctly documenting the affected declarations depend on QDoc evaluating it correctly. As QDoc currently cannot evaluate complex preprocessor directives, work around this by explicitly evaluating the version check to false. Change-Id: If22eff76f6831c92375d9a0b25d04aa46422da13 Task-number: QTBUG-51262 Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
2016-02-19 14:16:31 +00:00
# Qt 6: Remove
falsehoods += \
Correct the documented visibility of some Widget methods Specifically, commit e80a3b49c0aac237104e1696fc64b3a924c89ca1 introduced the use of some QT_VERSION_CHECK macros to distinguish some methods' visibility between Qt 5 and Qt 6, however the QDoc falsehoods variable (added sometime prior) was sensitive to whitespace, and did not correctly recognize those version checks. This resulted in some methods being incorrectly documented as public instead of protected, or vice versa. This change simply makes the QT_VERSION_CHECK in QDoc falsehoods allow for optional whitespace. Methods affected by this change (in documentation only): * QListWidget::dropEvent() * QTableWidget::items(), ::indexFromItem(), itemFromIndex() * QTreeWidget::items(), ::indexFromItem(), and itemFromIndex() Task-number: QTBUG-68005 Change-Id: Ibe3e780334a9a915989ed43b5cdda6915c9161ec Reviewed-by: Luca Beldi <v.ronin@yahoo.it> Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com> Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2018-05-01 13:03:35 +00:00
"QT_VERSION >= QT_VERSION_CHECK\\(\\s*6\\s*,\\s*0\\s*,\\s*0\\s*\\)"
qdoc: Exclude platform dependent .cpp files clangqdoc can't parse platform dependent source files because they try to include platform dependent system include files. e.g., When clangqdoc is run on macOS, the Windows system include files are not available. This change adds all the platform dependent .cpp files to the excludefiles config variable. This means that qdoc comments are no longer allowed in the excluded files. There shouldn't be any documentation in these files anyway. Platform dependent documentation should be in .qdoc files or in generic .cpp files that do not try to include platform dependent include files. Note that .m and .mm files are excluded programatically in qdoc. Change-Id: I8f93fe9f5604e558b3df8c8cc8ee723010bf885d Reviewed-by: Martin Smith <martin.smith@qt.io>
2016-09-22 07:48:51 +00:00
excludefiles += \
"*_posix.cpp" \
"*_android.cpp" \
"*_win.cpp" \
"*_icu.cpp" \
"*_msvc.cpp" \
"*_wince.cpp" \
"*_winrt.cpp" \
"*_mac.cpp" \
"*_macx.cpp" \
"*_unix.cpp" \
"*_udev.cpp" \
"*_vxworks.cpp" \
Doc: Do not exclude *_x11.cpp files from the documentation build QX11Info class from the Qt X11 Extras module is documented in qx11info_x11.cpp, and it needs to be parsed. Change-Id: I32e8415d93e67dbf16267d4af63979c1db0870b0 Reviewed-by: Andy Shaw <andy.shaw@qt.io>
2017-06-08 12:27:01 +00:00
"*_darwin.cpp"
Reference in New Issue Copy Permalink