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 Pick-to: 6.2 6.1 Change-Id: I16b2a7a2fbaf4785c2c6bfa5017a3db46d9db2f4 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
parent
61d4f7e228
commit
fd86939eaf
@ -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&=()
|
||||
*/
|
||||
|
Loading…
Reference in New Issue
Block a user