From 06db30d2b5da9bef50d7c278110acb937d5bc924 Mon Sep 17 00:00:00 2001 From: Luca Di Sera Date: Fri, 3 Nov 2023 15:31:24 +0100 Subject: Doc: Fix template information in "qsharedpointer.cpp" MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. Some of the documented callables in "qsharedpointer.cpp" are not in sync with the template declaration of their intended target. Hence, add the missing information to the relevant "\fn" commands. Task-number: QTBUG-118080 Change-Id: Iadac55e944aa425205b9d1cd8b4189ffacb4a089 Reviewed-by: Topi Reiniö --- src/corelib/tools/qsharedpointer.cpp | 38 ++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 19 deletions(-) (limited to 'src/corelib/tools/qsharedpointer.cpp') diff --git a/src/corelib/tools/qsharedpointer.cpp b/src/corelib/tools/qsharedpointer.cpp index 6daf1e3fad..4b275ac1ba 100644 --- a/src/corelib/tools/qsharedpointer.cpp +++ b/src/corelib/tools/qsharedpointer.cpp @@ -988,7 +988,7 @@ */ /*! - \fn template template bool operator==(const QSharedPointer &ptr1, const QSharedPointer &ptr2) + \fn template bool operator==(const QSharedPointer &ptr1, const QSharedPointer &ptr2) \relates QSharedPointer Returns \c true if \a ptr1 and \a ptr2 refer to the same pointer. @@ -1001,7 +1001,7 @@ */ /*! - \fn template template bool operator!=(const QSharedPointer &ptr1, const QSharedPointer &ptr2) + \fn template bool operator!=(const QSharedPointer &ptr1, const QSharedPointer &ptr2) \relates QSharedPointer Returns \c true if \a ptr1 and \a ptr2 refer to distinct pointers. @@ -1014,7 +1014,7 @@ */ /*! - \fn template template bool operator==(const QSharedPointer &ptr1, const X *ptr2) + \fn template bool operator==(const QSharedPointer &ptr1, const X *ptr2) \relates QSharedPointer Returns \c true if \a ptr1 and \a ptr2 refer to the same pointer. @@ -1027,7 +1027,7 @@ */ /*! - \fn template template bool operator!=(const QSharedPointer &ptr1, const X *ptr2) + \fn template bool operator!=(const QSharedPointer &ptr1, const X *ptr2) \relates QSharedPointer Returns \c true if \a ptr1 and \a ptr2 refer to distinct pointers. @@ -1040,7 +1040,7 @@ */ /*! - \fn template template bool operator==(const T *ptr1, const QSharedPointer &ptr2) + \fn template bool operator==(const T *ptr1, const QSharedPointer &ptr2) \relates QSharedPointer Returns \c true if the pointer \a ptr1 is the @@ -1054,7 +1054,7 @@ */ /*! - \fn template template bool operator!=(const T *ptr1, const QSharedPointer &ptr2) + \fn template bool operator!=(const T *ptr1, const QSharedPointer &ptr2) \relates QSharedPointer Returns \c true if the pointer \a ptr1 is not the @@ -1068,7 +1068,7 @@ */ /*! - \fn template template bool operator==(const QSharedPointer &ptr1, const QWeakPointer &ptr2) + \fn template bool operator==(const QSharedPointer &ptr1, const QWeakPointer &ptr2) \relates QWeakPointer Returns \c true if \a ptr1 and \a ptr2 refer to the same pointer. @@ -1081,7 +1081,7 @@ */ /*! - \fn template template bool operator!=(const QSharedPointer &ptr1, const QWeakPointer &ptr2) + \fn template bool operator!=(const QSharedPointer &ptr1, const QWeakPointer &ptr2) \relates QWeakPointer Returns \c true if \a ptr1 and \a ptr2 refer to distinct pointers. @@ -1094,7 +1094,7 @@ */ /*! - \fn template template bool operator==(const QWeakPointer &ptr1, const QSharedPointer &ptr2) + \fn template bool operator==(const QWeakPointer &ptr1, const QSharedPointer &ptr2) \relates QWeakPointer Returns \c true if \a ptr1 and \a ptr2 refer to the same pointer. @@ -1187,7 +1187,7 @@ */ /*! - \fn template template bool operator!=(const QWeakPointer &ptr1, const QSharedPointer &ptr2) + \fn template bool operator!=(const QWeakPointer &ptr1, const QSharedPointer &ptr2) \relates QWeakPointer Returns \c true if \a ptr1 and \a ptr2 refer to distinct pointers. @@ -1200,7 +1200,7 @@ */ /*! - \fn template template QSharedPointer qSharedPointerCast(const QSharedPointer &other) + \fn template QSharedPointer qSharedPointerCast(const QSharedPointer &other) \relates QSharedPointer Returns a shared pointer to the pointer held by \a other, cast to @@ -1215,7 +1215,7 @@ */ /*! - \fn template template QSharedPointer qSharedPointerCast(const QWeakPointer &other) + \fn template QSharedPointer qSharedPointerCast(const QWeakPointer &other) \relates QSharedPointer \relates QWeakPointer @@ -1236,7 +1236,7 @@ */ /*! - \fn template template QSharedPointer qSharedPointerDynamicCast(const QSharedPointer &src) + \fn template QSharedPointer qSharedPointerDynamicCast(const QSharedPointer &src) \relates QSharedPointer Returns a shared pointer to the pointer held by \a src, using a @@ -1252,7 +1252,7 @@ */ /*! - \fn template template QSharedPointer qSharedPointerDynamicCast(const QWeakPointer &src) + \fn template QSharedPointer qSharedPointerDynamicCast(const QWeakPointer &src) \relates QSharedPointer \relates QWeakPointer @@ -1274,7 +1274,7 @@ */ /*! - \fn template template QSharedPointer qSharedPointerConstCast(const QSharedPointer &src) + \fn template QSharedPointer qSharedPointerConstCast(const QSharedPointer &src) \relates QSharedPointer Returns a shared pointer to the pointer held by \a src, cast to @@ -1286,7 +1286,7 @@ */ /*! - \fn template template QSharedPointer qSharedPointerConstCast(const QWeakPointer &src) + \fn template QSharedPointer qSharedPointerConstCast(const QWeakPointer &src) \relates QSharedPointer \relates QWeakPointer @@ -1304,7 +1304,7 @@ */ /*! - \fn template template QSharedPointer qSharedPointerObjectCast(const QSharedPointer &src) + \fn template QSharedPointer qSharedPointerObjectCast(const QSharedPointer &src) \relates QSharedPointer \since 4.6 @@ -1376,7 +1376,7 @@ */ /*! - \fn template template QSharedPointer qSharedPointerObjectCast(const QWeakPointer &src) + \fn template QSharedPointer qSharedPointerObjectCast(const QWeakPointer &src) \relates QSharedPointer \relates QWeakPointer \since 4.6 @@ -1402,7 +1402,7 @@ /*! - \fn template template QWeakPointer qWeakPointerCast(const QWeakPointer &src) + \fn template QWeakPointer qWeakPointerCast(const QWeakPointer &src) \relates QWeakPointer Returns a weak pointer to the pointer held by \a src, cast to -- cgit v1.2.3