diff options
| author | Marc Mutz <marc.mutz@qt.io> | 2024-10-09 12:43:20 +0200 |
|---|---|---|
| committer | Marc Mutz <marc.mutz@qt.io> | 2024-11-27 12:39:55 +0100 |
| commit | 906aa1533f2267b091615d21c2d31e1742f0a520 (patch) | |
| tree | d1591a253674fd2bd4cfca5006ac6b68371ae482 /src/corelib/time/qdatetime.cpp | |
| parent | 4502025dcdd09c7821b793739fafb1565ddf5b52 (diff) | |
Create qdoc macros for C++ class docs 2.1: qHash()
Add a family of qdoc macros to document the various qHash() overloads
we have.
This patch does not change the \relates of the qHash() functions, they
remain as inconsistent as they have been. Created QTBUG-129815 to
clean things up. Since this author expects the \relates to change in
the future, there are different \qhash commands, and all except
\qhashbuiltin take the class name as an argument, for use in a
centrally-choreographed fix for QTBUG-129815.
As drive-by's, fix:
- missing documentation about Key having to support qHash() in the
associative Qt containers
- drop noexcept and default arguments from \fn lines that needed to
have their argument names changed
- move the QStringView overload from qhash.cpp to qstringview.cpp
(as it \relates to the former)
Fixes: QTBUG-129574
Pick-to: 6.8 6.5
Change-Id: I8e8c2edc27422cbe5823f56baf3a24d7f7050836
Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io>
Diffstat (limited to 'src/corelib/time/qdatetime.cpp')
| -rw-r--r-- | src/corelib/time/qdatetime.cpp | 12 |
1 files changed, 3 insertions, 9 deletions
diff --git a/src/corelib/time/qdatetime.cpp b/src/corelib/time/qdatetime.cpp index e9a0bd07f84..0ec01da2be2 100644 --- a/src/corelib/time/qdatetime.cpp +++ b/src/corelib/time/qdatetime.cpp @@ -6273,10 +6273,8 @@ QDebug operator<<(QDebug dbg, const QDateTime &date) #endif // debug_stream && datestring /*! \fn size_t qHash(const QDateTime &key, size_t seed = 0) - \relates QHash + \qhashold{QHash} \since 5.0 - - Returns the hash value for the \a key, using \a seed to seed the calculation. */ size_t qHash(const QDateTime &key, size_t seed) { @@ -6288,10 +6286,8 @@ size_t qHash(const QDateTime &key, size_t seed) } /*! \fn size_t qHash(QDate key, size_t seed = 0) - \relates QHash + \qhashold{QHash} \since 5.0 - - Returns the hash value for the \a key, using \a seed to seed the calculation. */ size_t qHash(QDate key, size_t seed) noexcept { @@ -6299,10 +6295,8 @@ size_t qHash(QDate key, size_t seed) noexcept } /*! \fn size_t qHash(QTime key, size_t seed = 0) - \relates QHash + \qhashold{QHash} \since 5.0 - - Returns the hash value for the \a key, using \a seed to seed the calculation. */ size_t qHash(QTime key, size_t seed) noexcept { |