whytofly
/
qt6-bb10
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: Fix template information for QPointer members 

When QDoc parses a project, it parses the source code to extract the
user-provided documentation and perform sanity checkings based on the
code itself on it.

When QDoc parses an "\fn" command as part of this process, it tries to
understand, based on its intermediate representation built on the
information extracted from the code-base, which "documentable element"
the "\fn" refers to.

When QDoc performs this "matching" process, it takes into consideration
only a certain amount of information.
For example, no checking is performed over the template declaration of a
callable.

Due to some upcoming documentation, where two callables are
indistinguishable to the current process, as they differ only in their
template declaration, QDoc will start to take into consideration the
template declaration of a callable when matching.

This implies that an "\fn" command should now provide information
parity, with regards to template declaration for callables, with the
code-base so that QDoc can perform the match correctly.

The documentation for some of the members of `QPointer` is not in sync
with the intended target template declaration.

Hence, add the missing information to the relevant "\fn" commands.

Task-number: QTBUG-118080
Change-Id: Iefaa12a4ac4f05cb5dbadd126b920cfc6a118d91
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
bb10
Luca Di Sera 2023-11-03 15:39:25 +01:00
parent 4ccd4118f4
commit e5970cbfd4
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/corelib/kernel/qpointer.qdoc
View File

@ -99,8 +99,8 @@
*/
/*!
\fn template <class T> template <class X> QPointer<T>::QPointer(QPointer<X> &&other)
\fn template <class T> template <class X> QPointer<T>::QPointer(const QPointer<X> &other)
\fn template <class T> template <typename X, if_convertible<X> = true> QPointer<T>::QPointer(QPointer<X> &&other)
\fn template <class T> template <typename X, if_convertible<X> = true> QPointer<T>::QPointer(const QPointer<X> &other)
\since 6.6
Conversion constructor. Constructs a new QPointer by moving or copying from
@ -113,7 +113,7 @@
*/
/*!
\fn template <class T> template <class X> QPointer<T> &QPointer<T>::operator=(const QPointer<X> &other)
\fn template <class T> template <typename X, if_convertible<X> = true> QPointer<T> &QPointer<T>::operator=(const QPointer<X> &other)
\since 6.6
Conversion assignment operator. Makes this guarded pointer guard the
@ -124,7 +124,7 @@
*/
/*!
\fn template <class T> template <class X> QPointer<T> &QPointer<T>::operator=(QPointer<X> &&other)
\fn template <class T> template <typename X, if_convertible<X> = true> &QPointer<T>::operator=(QPointer<X> &&other)
\since 6.6.1
Conversion move-assignment operator. Makes this guarded pointer guard the
@ -202,7 +202,7 @@
*/
/*!
\fn template <typename T, typename X> bool QPointer<T>::operator==(X *o, const QPointer<T> &p)
\fn template <typename T> template<typename X> bool QPointer<T>::operator==(X *o, const QPointer<T> &p)
Equality operator. Returns \c true if \a o and the guarded
pointer \a p are pointing to the same object, otherwise
@ -210,7 +210,7 @@
*/
/*!
\fn template <typename T, typename X> bool QPointer<T>::operator==(const QPointer<T> &p, X *o)
\fn template <typename T> template<typename X> bool QPointer<T>::operator==(const QPointer<T> &p, X *o)
Equality operator. Returns \c true if \a o and the guarded
pointer \a p are pointing to the same object, otherwise
@ -218,7 +218,7 @@
*/
/*!
\fn template <typename T, typename X> bool QPointer<T>::operator==(const QPointer<T> &p1, const QPointer<X> &p2)
\fn template <typename T> template<typename X> bool QPointer<T>::operator==(const QPointer<T> &p1, const QPointer<X> &p2)
Equality operator. Returns \c true if the guarded pointers \a p1 and \a p2
are pointing to the same object, otherwise
@ -241,21 +241,21 @@
*/
/*!
\fn template <typename T, typename X> bool QPointer<T>::operator!=(const QPointer<T> &p, X *o)
\fn template <typename T> template<typename X> bool QPointer<T>::operator!=(const QPointer<T> &p, X *o)
Inequality operator. Returns \c true if \a o and the guarded
pointer \a p are not pointing to the same object, otherwise
returns \c false.
*/
/*!
\fn template <typename T, typename X> bool QPointer<T>::operator!=(X *o, const QPointer<T> &p)
\fn template <typename T> template<typename X> bool QPointer<T>::operator!=(X *o, const QPointer<T> &p)
Inequality operator. Returns \c true if \a o and the guarded
pointer \a p are not pointing to the same object, otherwise
returns \c false.
*/
/*!
\fn template <typename T, typename X> bool QPointer<T>::operator!=(const QPointer<T> &p1, const QPointer<X> &p2)
\fn template <typename T> template<typename X> bool QPointer<T>::operator!=(const QPointer<T> &p1, const QPointer<X> &p2)
Inequality operator. Returns \c true if the guarded pointers \a p1 and
\a p2 are not pointing to the same object, otherwise