diff options
author | Luca Di Sera <luca.disera@qt.io> | 2021-08-16 13:10:25 +0200 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-08-18 21:42:49 +0000 |
commit | c9c545eb4c48b28e81eaeb9a7e31fbd1fb246ddb (patch) | |
tree | 2cdc356db5243459ca24835314ca3a54492bbdab | |
parent | 6caa4e3aa00f8c362d1c920a75d611b9bfdd9753 (diff) |
Doc: Add missing links to methods to QSet documentation page
Some internal links to `QSet` methods were missing from the
documentation. In particular, all methods that were written with one
attribute.
It seems that QDoc might automatically recognize method/function
links only if they have zero parameters, such that the identifier is
followed by `()` directly.
To avoid this problem while keeping the current parameter-containing
form of the text; each function of the form `functioname(\a
parametername)` was changed to `\l {functionname()} {functioname(\a
parametername)}.
Furthermore, one of those text instances was modified to use `\a` for
the parameter name, instead of the previously used `\e`, to enhance
consistency.
An instance of `operator<<()` was not recognized as a link.
To resolve this it was marked with the `\l` command.
Fixes: QTBUG-95389
Change-Id: I16b2a7a2fbaf4785c2c6bfa5017a3db46d9db2f4
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
(cherry picked from commit fd86939eaf73c5e58e12b7eb2cd0563c03d33ba9)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r-- | src/corelib/tools/qset.qdoc | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/corelib/tools/qset.qdoc b/src/corelib/tools/qset.qdoc index de3c125325..4b830c9cb7 100644 --- a/src/corelib/tools/qset.qdoc +++ b/src/corelib/tools/qset.qdoc @@ -47,7 +47,7 @@ \snippet code/doc_src_qset.cpp 1 - Another way to insert items into the set is to use operator<<(): + Another way to insert items into the set is to use \l operator<<(): \snippet code/doc_src_qset.cpp 2 @@ -559,7 +559,7 @@ \fn template <class T> QSet<T> &QSet<T>::operator|=(const QSet<T> &other) \fn template <class T> QSet<T> &QSet<T>::operator+=(const QSet<T> &other) - Same as unite(\a other). + Same as \l {unite()} {unite(\a other)}. \sa operator|(), operator&=(), operator-=() */ @@ -567,7 +567,7 @@ /*! \fn template <class T> QSet<T> &QSet<T>::operator&=(const QSet<T> &other) - Same as intersect(\a other). + Same as \l {intersect()} {intersect(\a other)}. \sa operator&(), operator|=(), operator-=() */ @@ -577,7 +577,7 @@ \overload - Same as intersect(\e{other}), if we consider \e{other} to be a set + Same as \l {intersect()} {intersect(\a{other})}, if we consider \a other to be a set that contains the singleton \a value. */ @@ -585,7 +585,7 @@ /*! \fn template <class T> QSet<T> &QSet<T>::operator-=(const QSet<T> &other) - Same as subtract(\a{other}). + Same as \l {subtract()} {subtract(\a{other})}. \sa operator-(), operator|=(), operator&=() */ |