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>

5 files changed, 7 insertions, 29 deletions

diff --git a/src/gui/kernel/qcursor.cpp b/src/gui/kernel/qcursor.cpp
index 9e97470dfb..e70f6ac79b 100644
--- a/src/gui/kernel/qcursor.cpp
+++ b/src/gui/kernel/qcursor.cpp
@@ -480,8 +480,7 @@ QCursor::QCursor(Qt::CursorShape shape)
 }
 
 /*!
-    \fn bool operator==(const QCursor &lhs, const QCursor &rhs)
-    \relates QCursor
+    \fn bool QCursor::operator==(const QCursor &lhs, const QCursor &rhs)
     \since 5.10
 
     Equality operator. Returns \c true if \a lhs and \a rhs
@@ -519,8 +518,7 @@ bool operator==(const QCursor &lhs, const QCursor &rhs) noexcept
 }
 
 /*!
-    \fn bool operator!=(const QCursor &lhs, const QCursor &rhs)
-    \relates QCursor
+    \fn bool QCursor::operator!=(const QCursor &lhs, const QCursor &rhs)
     \since 5.10
 
     Inequality operator. Returns the equivalent of !(\a lhs == \a rhs).
diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp
index 5938942399..b60672ce17 100644
--- a/src/gui/kernel/qevent.cpp
+++ b/src/gui/kernel/qevent.cpp
@@ -274,7 +274,7 @@ QEventPoint &QEventPoint::operator=(const QEventPoint &other)
 */
 
 /*!
-    \fn QEventPoint &QEventPoint QEventPoint::operator=(QEventPoint &&other) noexcept
+    \fn QEventPoint &QEventPoint::operator=(QEventPoint &&other) noexcept
 
     Move-assigns \a other to this event point instance.
 */
diff --git a/src/gui/kernel/qpalette.cpp b/src/gui/kernel/qpalette.cpp
index da418c7eed..f5d010aa26 100644
--- a/src/gui/kernel/qpalette.cpp
+++ b/src/gui/kernel/qpalette.cpp
@@ -158,13 +158,6 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button)
 */
 
 /*!
-    \fn const QBrush & QPalette::foreground() const
-    \obsolete
-
-    Use windowText() instead.
-*/
-
-/*!
     \fn const QBrush & QPalette::windowText() const
 
     Returns the window text (general foreground) brush of the
@@ -280,13 +273,6 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button)
 */
 
 /*!
-    \fn const QBrush & QPalette::background() const
-    \obsolete
-
-    Use window() instead.
-*/
-
-/*!
     \fn const QBrush & QPalette::window() const
 
     Returns the window (general background) brush of the current
@@ -451,12 +437,8 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button)
 
     \value Window  A general background color.
 
-    \value Background  This value is obsolete. Use Window instead.
-
     \value WindowText  A general foreground color.
 
-    \value Foreground  This value is obsolete. Use WindowText instead.
-
     \value Base  Used mostly as the background color for text entry widgets,
                  but can also be used for other painting - such as the
                  background of combobox drop down lists and toolbar handles.
diff --git a/src/gui/painting/qcolorspace.cpp b/src/gui/painting/qcolorspace.cpp
index a4ae294793..82aec1e50f 100644
--- a/src/gui/painting/qcolorspace.cpp
+++ b/src/gui/painting/qcolorspace.cpp
@@ -691,6 +691,7 @@ bool QColorSpace::isValid() const noexcept
 }
 
 /*!
+    \fn bool QColorSpace::operator==(const QColorSpace &colorSpace1, const QColorSpace &colorSpace2)
     \relates QColorSpace
     Returns \c true if colorspace \a colorSpace1 is equal to colorspace \a colorSpace2;
     otherwise returns \c false
@@ -742,8 +743,7 @@ bool operator==(const QColorSpace &colorSpace1, const QColorSpace &colorSpace2)
 }
 
 /*!
-    \fn bool operator!=(const QColorSpace &colorSpace1, const QColorSpace &colorSpace2)
-    \relates QColorSpace
+    \fn bool QColorSpace::operator!=(const QColorSpace &colorSpace1, const QColorSpace &colorSpace2)
 
     Returns \c true if colorspace \a colorSpace1 is not equal to colorspace \a colorSpace2;
     otherwise returns \c false
diff --git a/src/gui/text/qtextlayout.cpp b/src/gui/text/qtextlayout.cpp
index bec1f4a542..6c18c53bca 100644
--- a/src/gui/text/qtextlayout.cpp
+++ b/src/gui/text/qtextlayout.cpp
@@ -93,15 +93,13 @@ QT_BEGIN_NAMESPACE
     Specifies the format to apply.
 */
 
-/*! \fn bool operator==(const QTextLayout::FormatRange &lhs, const QTextLayout::FormatRange &rhs)
-  \relates QTextLayout::FormatRange
+/*! \fn bool QTextLayout::FormatRange::operator==(const QTextLayout::FormatRange &lhs, const QTextLayout::FormatRange &rhs)
 
   Returns true if the \c {start}, \c {length}, and \c {format} fields
   in \a lhs and \a rhs contain the same values respectively.
  */
 
-/*! \fn bool operator!=(const QTextLayout::FormatRange &lhs, const QTextLayout::FormatRange &rhs)
-  \relates QTextLayout::FormatRange
+/*! \fn bool QTextLayout::FormatRange::operator!=(const QTextLayout::FormatRange &lhs, const QTextLayout::FormatRange &rhs)
 
   Returns true if any of the \c {start}, \c {length}, or \c {format} fields
   in \a lhs and \a rhs contain different values respectively.