From e5bc777e5051a5b24b5e241072042631bd69fc22 Mon Sep 17 00:00:00 2001
From: Volker Hilsheimer <volker.hilsheimer@qt.io>
Date: Fri, 23 Oct 2020 08:31:30 +0200
Subject: Fix documentation warnings

Declare hidden friends like qdoc expects them, and other signature fixes
Document function parameters
Remove documentation for removed APIs.

Change-Id: I44c1caeed0d40be04612129d074acc30b75f5259
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
---
 src/corelib/kernel/qpointer.cpp | 58 ++++++++++++++++-------------------------
 1 file changed, 23 insertions(+), 35 deletions(-)

(limited to 'src/corelib/kernel')

diff --git a/src/corelib/kernel/qpointer.cpp b/src/corelib/kernel/qpointer.cpp
index 5f6826b269..737d73c4b8 100644
--- a/src/corelib/kernel/qpointer.cpp
+++ b/src/corelib/kernel/qpointer.cpp
@@ -201,8 +201,7 @@
 */
 
 /*!
-    \fn template <class T> bool operator==(const T *o, const QPointer<T> &p)
-    \relates QPointer
+    \fn template <typename T, 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,8 +209,7 @@
 
 */
 /*!
-    \fn template <class T> bool operator==(const QPointer<T> &p, const T *o)
-    \relates QPointer
+    \fn template <typename T, 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
@@ -219,74 +217,64 @@
 
 */
 /*!
-    \fn template <class T> bool operator==(T *o, const QPointer<T> &p)
-    \relates QPointer
+    \fn template <typename T, typename X> bool QPointer<T>::operator==(const QPointer<T> &p1, const QPointer<X> &p2)
 
-    Equality operator. Returns \c true if \a o and the guarded
-    pointer \a p are pointing to the same object, otherwise
+    Equality operator. Returns \c true if the guarded pointers \a p1 and \a p2
+    are pointing to the same object, otherwise
     returns \c false.
 
 */
 /*!
-    \fn template <class T> bool operator==(const QPointer<T> &p, T *o)
-    \relates QPointer
+    \fn template <typename T> bool QPointer<T>::operator==(std::nullptr_t, const QPointer<T> &rhs)
 
-    Equality operator. Returns \c true if \a o and the guarded
-    pointer \a p are pointing to the same object, otherwise
+    Equality operator. Returns \c true if the pointer guarded by \a rhs
+    is \nullptr, otherwise
     returns \c false.
-
 */
 /*!
-    \fn template <class T> bool operator==(const QPointer<T> &p1, const QPointer<T> &p2)
-    \relates QPointer
+    \fn template <typename T> bool QPointer<T>::operator==(const QPointer<T> &lhs, std::nullptr_t)
 
-    Equality operator. Returns \c true if the guarded pointers \a p1 and \a p2
-    are pointing to the same object, otherwise
+    Equality operator. Returns \c true if the pointer guarded by \a lhs
+    is \nullptr, otherwise
     returns \c false.
-
 */
 
-
 /*!
-    \fn template <class T> bool operator!=(const T *o, const QPointer<T> &p)
-    \relates QPointer
+    \fn template <typename T, 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 <class T> bool operator!=(const QPointer<T> &p, const T *o)
-    \relates QPointer
+    \fn template <typename T, 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 <class T> bool operator!=(T *o, const QPointer<T> &p)
-    \relates QPointer
+    \fn template <typename T, typename X> bool QPointer<T>::operator!=(const QPointer<T> &p1, const QPointer<X> &p2)
 
-    Inequality operator. Returns \c true if \a o and the guarded
-    pointer \a p are not pointing to the same object, otherwise
+    Inequality operator. Returns \c true if  the guarded pointers \a p1 and
+    \a p2 are not pointing to the same object, otherwise
     returns \c false.
 */
 /*!
-    \fn template <class T> bool operator!=(const QPointer<T> &p, T *o)
-    \relates QPointer
+    \fn template <typename T> bool QPointer<T>::operator!=(std::nullptr_t, const QPointer<T> &rhs)
 
-    Inequality operator. Returns \c true if \a o and the guarded
-    pointer \a p are not pointing to the same object, otherwise
+    Inequality operator. Returns \c true if the pointer guarded by \a rhs is
+    a valid (ie not \nullptr) pointer, otherwise
     returns \c false.
 */
 /*!
-    \fn template <class T> bool operator!=(const QPointer<T> &p1, const QPointer<T> &p2)
-    \relates QPointer
+    \fn template <typename T> bool QPointer<T>::operator!=(const QPointer<T> &lhs, std::nullptr_t)
 
-    Inequality operator. Returns \c true if  the guarded pointers \a p1 and
-    \a p2 are not pointing to the same object, otherwise
+    Inequality operator. Returns \c true if the pointer guarded by \a lhs is
+    a valid (ie not \nullptr) pointer, otherwise
     returns \c false.
 */
+
 /*!
     \fn template <typename T> QPointer<T> qPointerFromVariant(const QVariant &variant)
 
-- 
cgit v1.2.3