diff options
author | Nico Vertriest <nico.vertriest@qt.io> | 2021-06-01 11:38:06 +0200 |
---|---|---|
committer | Nico Vertriest <nico.vertriest@qt.io> | 2021-07-23 10:39:04 +0000 |
commit | a2c8184b6b241b063e9af005edf082e653dfd8a6 (patch) | |
tree | 3ff275501cbe2934dbc7309b4f4513b1d6d52757 /src/corelib/tools | |
parent | 53e4a50c6b3c7359b9afc24f30c9517abdf9561a (diff) |
Doc: Ensure deprecated APIs in Qt Core are documented as such
Added \deprecated [version_since] when needed
Remove references to deprecated functions in \sa statements
Fixes: QTBUG-94534
Pick-to: 6.2
Change-Id: I3b3d4277d63fc5d6d207c28ff2484aed30b83247
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
Diffstat (limited to 'src/corelib/tools')
-rw-r--r-- | src/corelib/tools/qhash.cpp | 8 | ||||
-rw-r--r-- | src/corelib/tools/qscopedpointer.cpp | 6 |
2 files changed, 7 insertions, 7 deletions
diff --git a/src/corelib/tools/qhash.cpp b/src/corelib/tools/qhash.cpp index 38c3f9cef6..fe3d8d912e 100644 --- a/src/corelib/tools/qhash.cpp +++ b/src/corelib/tools/qhash.cpp @@ -877,14 +877,14 @@ void QHashSeed::resetRandomGlobalSeed() #if QT_DEPRECATED_SINCE(6,6) /*! \relates QHash \since 5.6 - \deprecated Use QHashSeed::globalSeed() instead. + \deprecated [6.6] Use QHashSeed::globalSeed() instead. Returns the current global QHash seed. The seed is set in any newly created QHash. See \l{qHash} about how this seed is being used by QHash. - \sa qSetGlobalQHashSeed, QHashSeed::globalSeed() + \sa QHashSeed, QHashSeed::globalSeed() */ int qGlobalQHashSeed() { @@ -893,7 +893,7 @@ int qGlobalQHashSeed() /*! \relates QHash \since 5.6 - \deprecated Use QHashSeed instead. + \deprecated [6.6] Use QHashSeed instead. Sets the global QHash seed to \a newSeed. @@ -913,7 +913,7 @@ int qGlobalQHashSeed() If the environment variable \c QT_HASH_SEED is set, calling this function will result in a no-op. - \sa qGlobalQHashSeed, QHashSeed + \sa qHashSeed::globalSeed, QHashSeed */ void qSetGlobalQHashSeed(int newSeed) { diff --git a/src/corelib/tools/qscopedpointer.cpp b/src/corelib/tools/qscopedpointer.cpp index 8146fe33cf..1844013d46 100644 --- a/src/corelib/tools/qscopedpointer.cpp +++ b/src/corelib/tools/qscopedpointer.cpp @@ -248,7 +248,7 @@ QT_BEGIN_NAMESPACE /*! \fn template <typename T, typename Cleanup> T *QScopedPointer<T, Cleanup>::take() - \deprecated Use std::unique_ptr and release() instead. + \deprecated [6.1] Use \c std::unique_ptr and \c release() instead. Returns the value of the pointer referenced by this object. The pointer of this QScopedPointer object will be reset to \nullptr. @@ -265,7 +265,7 @@ QT_BEGIN_NAMESPACE /*! \fn template <typename T, typename Cleanup> void QScopedPointer<T, Cleanup>::swap(QScopedPointer<T, Cleanup> &lhs, QScopedPointer<T, Cleanup> &rhs) - \deprecated Use std::unique_ptr instead; this function may let a pointer + \deprecated [6.1] Use \c std::unique_ptr instead; this function may let a pointer escape its scope. Swaps \a lhs with \a rhs. @@ -335,7 +335,7 @@ QT_BEGIN_NAMESPACE /*! \fn template <typename T, typename Cleanup> void QScopedArrayPointer<T, Cleanup>::swap(QScopedArrayPointer<T, Cleanup> &other) - \deprecated Use std::unique_ptr instead; this function may let a pointer + \deprecated [6.1] Use \c std::unique_ptr instead; this function may let a pointer escape its scope. Swap this pointer with \a other. |