diff options
author | Sona Kurazyan <sona.kurazyan@qt.io> | 2022-09-19 17:00:27 +0200 |
---|---|---|
committer | Sona Kurazyan <sona.kurazyan@qt.io> | 2022-09-22 13:48:15 +0200 |
commit | f7bd53b2a633f2db45be9fb8cd2794370c65c608 (patch) | |
tree | 7583b3d2dd8da989914e9a66a339ccb56dbf79b3 /src/corelib/global/qtdeprecationmarkers.qdoc | |
parent | 3535f46374ccf8ad966e4b266c0dbd919646fded (diff) |
Move docs for deprecation macros to qtdeprecationmarkers.qdoc
Additionally:
- Generate the QtDeprecationMarkers fw header
- Add an overview page for QtDeprecationMarkers (otherwise the docs for
deprecated QT_DISABLE_DEPRECATED_BEFORE aren't generated)
- Fix docs to stop mentioning deprecated QT_DISABLE_DEPRECATED_BEFORE.
Task-number: QTBUG-106154
Change-Id: Ic8c45ba3d9d267036ca470b208676a3ac82485eb
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Diffstat (limited to 'src/corelib/global/qtdeprecationmarkers.qdoc')
-rw-r--r-- | src/corelib/global/qtdeprecationmarkers.qdoc | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/src/corelib/global/qtdeprecationmarkers.qdoc b/src/corelib/global/qtdeprecationmarkers.qdoc new file mode 100644 index 0000000000..2dd572533e --- /dev/null +++ b/src/corelib/global/qtdeprecationmarkers.qdoc @@ -0,0 +1,64 @@ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \headerfile <QtDeprecationMarkers> + \inmodule QtCore + \title Qt Deprecation Macros + + \brief The <QtDeprecationMarkers> header file contains deprecation helper macros. + + The header file declares several macros for disabling deprecated Qt APIs + and enabling/disabling compiler warnings when they are used. +*/ + +/*! + \macro QT_DISABLE_DEPRECATED_BEFORE + \relates <QtDeprecationMarkers> + \deprecated [6.5] Use QT_DISABLE_DEPRECATED_UP_TO instead + + \sa QT_DISABLE_DEPRECATED_UP_TO +*/ + +/*! + \macro QT_DISABLE_DEPRECATED_UP_TO + \relates <QtDeprecationMarkers> + + This macro can be defined in the project file to disable functions + deprecated in a specified version of Qt or any earlier version. The default + version number is 5.0, meaning that functions deprecated in or before + Qt 5.0 will not be included. + + For instance, when preparing to upgrade to Qt 6.3, after eliminating all + deprecation warnings, you can set \c{QT_DISABLE_DEPRECATED_UP_TO=0x060300} + to exclude from your builds the Qt APIs you no longer use. In your own + project's build configuration, this will ensure that anyone adding new calls + to the deprecated APIs will know about it right away. If you also build Qt + for yourself, including this define in your build configuration for Qt will + make your binaries smaller by leaving out even the implementation of the + deprecated APIs. + + \sa QT_DEPRECATED_WARNINGS, QT_DISABLE_DEPRECATED_UP_TO +*/ + +/*! + \macro QT_DEPRECATED_WARNINGS + \relates <QtDeprecationMarkers> + + Since Qt 5.13, this macro has no effect. In Qt 5.12 and before, if this macro + is defined, the compiler will generate warnings if any API declared as + deprecated by Qt is used. + + \sa QT_DISABLE_DEPRECATED_UP_TO, QT_NO_DEPRECATED_WARNINGS +*/ + +/*! + \macro QT_NO_DEPRECATED_WARNINGS + \relates <QtDeprecationMarkers> + \since 5.13 + + This macro can be used to suppress deprecation warnings that would otherwise + be generated when using deprecated APIs. + + \sa QT_DISABLE_DEPRECATED_UP_TO +*/ |