Skip to content

Commit 4c02701

Browse files
toreiniojaheikk
authored andcommitted
Doc: Fix incorrect \fn signatures
Several \fn signatures were either incorrect or missing qualifiers required to make QDoc match the documentation with the declarations. These were not caught in the CI when testing documentation builds due to a bug in QDoc. Task-number: QTBUG-134250 Change-Id: I7a4af11d9bc3687597b348cc2d4ee15212e0281f Reviewed-by: Thiago Macieira <[email protected]> (cherry picked from commit b6a01d7) Reviewed-by: Topi Reiniö <[email protected]> (cherry picked from commit f08721b) Reviewed-by: Volker Hilsheimer <[email protected]>
1 parent 457a863 commit 4c02701

File tree

4 files changed

+13
-14
lines changed

4 files changed

+13
-14
lines changed

src/corelib/kernel/qsocketnotifier.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ QSocketNotifier::~QSocketNotifier()
173173

174174

175175
/*!
176-
\fn void QSocketNotifier::activated(int socket)
176+
\fn void QSocketNotifier::activated(int socket, QPrivateSignal)
177177
\deprecated To avoid unintended truncation of the descriptor, use
178178
the QSocketDescriptor overload of this function. If you need
179179
compatibility with versions older than 5.15 you need to change

src/corelib/text/qstring.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8738,7 +8738,7 @@ static QString replaceArgEscapes(QStringView s, const ArgEscapeData &d, qsizetyp
87388738
}
87398739

87408740
/*!
8741-
\fn template <typename T, if_string_like<T> = true> QString QString::arg(const T &a, int fieldWidth, QChar fillChar) const
8741+
\fn template <typename T, QString::if_string_like<T> = true> QString QString::arg(const T &a, int fieldWidth, QChar fillChar) const
87428742
87438743
Returns a copy of this string with the lowest-numbered place-marker
87448744
replaced by string \a a, i.e., \c %1, \c %2, ..., \c %99.
@@ -8804,7 +8804,7 @@ QString QString::arg_impl(QAnyStringView a, int fieldWidth, QChar fillChar) cons
88048804
}
88058805

88068806
/*!
8807-
\fn template <typename T, if_integral_non_char<T> = true> QString QString::arg(T a, int fieldWidth, int base, QChar fillChar) const
8807+
\fn template <typename T, QString::if_integral_non_char<T> = true> QString QString::arg(T a, int fieldWidth, int base, QChar fillChar) const
88088808
\overload arg()
88098809
88108810
The \a a argument is expressed in base \a base, which is 10 by
@@ -8896,7 +8896,7 @@ QString QString::arg_impl(qulonglong a, int fieldWidth, int base, QChar fillChar
88968896
}
88978897

88988898
/*!
8899-
\fn template <typename T, if_floating_point<T> = true> QString QString::arg(T a, int fieldWidth, char format, int precision, QChar fillChar) const
8899+
\fn template <typename T, QString::if_floating_point<T> = true> QString QString::arg(T a, int fieldWidth, char format, int precision, QChar fillChar) const
89008900
\overload arg()
89018901
89028902
Argument \a a is formatted according to the specified \a format and

src/corelib/tools/qhash.cpp

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1240,7 +1240,7 @@ uint qt_hash(QStringView key, uint chained) noexcept
12401240
*/
12411241

12421242
/*!
1243-
\fn template <typname T, std::enable_if_t<std::is_same_v<T, bool>, bool> = true> size_t qHash(T key, size_t seed)
1243+
\fn template <typename T, std::enable_if_t<std::is_same_v<T, bool>, bool> = true> size_t qHash(T key, size_t seed)
12441244
\since 6.9
12451245
12461246
\qhashbuiltin
@@ -2339,7 +2339,7 @@ size_t qHash(long double key, size_t seed) noexcept
23392339
/*!
23402340
\fn template <class Key, class T> template <typename... Args> QHash<Key, T>::TryEmplaceResult QHash<Key, T>::tryEmplace(const Key &key, Args &&...args)
23412341
\fn template <class Key, class T> template <typename... Args> QHash<Key, T>::TryEmplaceResult QHash<Key, T>::tryEmplace(Key &&key, Args &&...args)
2342-
\fn template <class Key, class T> template <typename K, typename... Args, if_heterogeneously_searchable<K> = true, if_key_constructible_from<K> = true> QHash<Key, T>::TryEmplaceResult QHash<Key, T>::tryEmplace(K &&key, Args &&...args)
2342+
\fn template <class Key, class T> template <typename K, typename... Args, QHash<Key, T>::if_heterogeneously_searchable<K> = true, QHash<Key, T>::if_key_constructible_from<K> = true> QHash<Key, T>::TryEmplaceResult QHash<Key, T>::tryEmplace(K &&key, Args &&...args)
23432343
\since 6.9
23442344
23452345
Inserts a new item with the \a key and a value constructed from \a args.
@@ -2382,7 +2382,7 @@ size_t qHash(long double key, size_t seed) noexcept
23822382

23832383
/*!
23842384
\fn template <class Key, class T> QHash<Key, T>::TryEmplaceResult QHash<Key, T>::tryInsert(const Key &key, const T &value)
2385-
\fn template <class Key, class T> template <typename K, if_heterogeneously_searchable<K> = true, if_key_constructible_from<K> = true> QHash<Key, T>::TryEmplaceResult QHash<Key, T>::tryInsert(K &&key, const T &value)
2385+
\fn template <class Key, class T> template <typename K, QHash<Key, T>::if_heterogeneously_searchable<K> = true, QHash<Key, T>::if_key_constructible_from<K> = true> QHash<Key, T>::TryEmplaceResult QHash<Key, T>::tryInsert(K &&key, const T &value)
23862386
\since 6.9
23872387
23882388
Inserts a new item with the \a key and a value of \a value.
@@ -2397,7 +2397,7 @@ size_t qHash(long double key, size_t seed) noexcept
23972397
*/
23982398

23992399
/*!
2400-
\fn template <class Key, class T> template <typename K, typename... Args, if_heterogeneously_searchable<K> = true, if_key_constructible_from<K> = true> QHash<Key, T>::try_emplace(const_iterator hint, K &&key, Args &&...args)
2400+
\fn template <class Key, class T> template <typename K, typename... Args, QHash<Key, T>::if_heterogeneously_searchable<K> = true, QHash<Key, T>::if_key_constructible_from<K> = true> iterator QHash<Key, T>::try_emplace(const_iterator hint, K &&key, Args &&...args)
24012401
\fn template <class Key, class T> template <typename... Args> iterator QHash<Key, T>::try_emplace(const_iterator hint, const Key &key, Args &&...args)
24022402
\fn template <class Key, class T> template <typename... Args> iterator QHash<Key, T>::try_emplace(const_iterator hint, Key &&key, Args &&...args)
24032403
\since 6.9
@@ -2418,7 +2418,7 @@ size_t qHash(long double key, size_t seed) noexcept
24182418
/*!
24192419
\fn template <class Key, class T> template <typename... Args> std::pair<iterator, bool> QHash<Key, T>::try_emplace(const Key &key, Args &&...args)
24202420
\fn template <class Key, class T> template <typename... Args> std::pair<iterator, bool> QHash<Key, T>::try_emplace(Key &&key, Args &&...args)
2421-
\fn template <class Key, class T> template <typename K, typename... Args, if_heterogeneously_searchable<K> = true, if_key_constructible_from<K> = true> QHash<Key, T>::try_emplace(K &&key, Args &&...args)
2421+
\fn template <class Key, class T> template <typename K, typename... Args, QHash<Key, T>::if_heterogeneously_searchable<K> = true, QHash<Key, T>::if_key_constructible_from<K> = true> std::pair<iterator, bool> QHash<Key, T>::try_emplace(K &&key, Args &&...args)
24222422
\since 6.9
24232423
24242424
Inserts a new item with the \a key and a value constructed from \a args.
@@ -2436,7 +2436,7 @@ size_t qHash(long double key, size_t seed) noexcept
24362436
/*!
24372437
\fn template <class Key, class T> template <typename Value> QHash<Key, T>::TryEmplaceResult QHash<Key, T>::insertOrAssign(const Key &key, Value &&value)
24382438
\fn template <class Key, class T> template <typename Value> QHash<Key, T>::TryEmplaceResult QHash<Key, T>::insertOrAssign(Key &&key, Value &&value)
2439-
\fn template <class Key, class T> template <typename K, typename Value, if_heterogeneously_searchable<K> = true, if_key_constructible_from<K> = true> QHash<Key, T>::TryEmplaceResult QHash<Key, T>::insertOrAssign(K &&key, Value &&value)
2439+
\fn template <class Key, class T> template <typename K, typename Value, QHash<Key, T>::if_heterogeneously_searchable<K> = true, QHash<Key, T>::if_key_constructible_from<K> = true> QHash<Key, T>::TryEmplaceResult QHash<Key, T>::insertOrAssign(K &&key, Value &&value)
24402440
\since 6.9
24412441
24422442
Attempts to insert an item with the \a key and \a value.
@@ -2453,7 +2453,7 @@ size_t qHash(long double key, size_t seed) noexcept
24532453
/*!
24542454
\fn template <class Key, class T> template <typename Value> std::pair<QHash<Key, T>::key_value_iterator, bool> QHash<Key, T>::insert_or_assign(const Key &key, Value &&value)
24552455
\fn template <class Key, class T> template <typename Value> std::pair<QHash<Key, T>::key_value_iterator, bool> QHash<Key, T>::insert_or_assign(Key &&key, Value &&value)
2456-
\fn template <class Key, class T> template <typename K, typename Value, if_heterogeneously_searchable<K> = true, if_key_constructible_from<K> = true> std::pair<QHash<Key, T>::key_value_iterator, bool> QHash<Key, T>::insert_or_assign(K &&key, Value &&value)
2456+
\fn template <class Key, class T> template <typename K, typename Value, QHash<Key, T>::if_heterogeneously_searchable<K> = true, QHash<Key, T>::if_key_constructible_from<K> = true> std::pair<QHash<Key, T>::key_value_iterator, bool> QHash<Key, T>::insert_or_assign(K &&key, Value &&value)
24572457
\since 6.9
24582458
24592459
Attempts to insert an item with the \a key and \a value.
@@ -2471,7 +2471,7 @@ size_t qHash(long double key, size_t seed) noexcept
24712471
/*!
24722472
\fn template <class Key, class T> template <typename Value> std::pair<QHash<Key, T>::key_value_iterator, bool> QHash<Key, T>::insert_or_assign(const_iterator hint, const Key &key, Value &&value)
24732473
\fn template <class Key, class T> template <typename Value> std::pair<QHash<Key, T>::key_value_iterator, bool> QHash<Key, T>::insert_or_assign(const_iterator hint, Key &&key, Value &&value)
2474-
\fn template <class Key, class T> template <typename K, typename Value, if_heterogeneously_searchable<K> = true, if_key_constructible_from<K> = true> std::pair<QHash<Key, T>::key_value_iterator, bool> QHash<Key, T>::insert_or_assign(const_iterator hint, K &&key, Value &&value)
2474+
\fn template <class Key, class T> template <typename K, typename Value, QHash<Key, T>::if_heterogeneously_searchable<K> = true, QHash<Key, T>::if_key_constructible_from<K> = true> std::pair<QHash<Key, T>::key_value_iterator, bool> QHash<Key, T>::insert_or_assign(const_iterator hint, K &&key, Value &&value)
24752475
\since 6.9
24762476
24772477
Attempts to insert an item with the \a key and \a value.

src/gui/math3d/qmatrix4x4.cpp

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -729,8 +729,7 @@ QMatrix4x4 operator/(const QMatrix4x4& matrix, float divisor)
729729
}
730730

731731
/*!
732-
\fn bool qFuzzyCompare(const QMatrix4x4& m1, const QMatrix4x4& m2)
733-
\relates QMatrix4x4
732+
\fn bool QMatrix4x4::qFuzzyCompare(const QMatrix4x4& m1, const QMatrix4x4& m2)
734733
735734
Returns \c true if \a m1 and \a m2 are equal, allowing for a small
736735
fuzziness factor for floating-point comparisons; false otherwise.

0 commit comments

Comments
 (0)