QRectF/QPointF/QSizeF: document that operator== and != are fuzzy

This has been the case for a _very_ long time, and I can't
believe this hasn't been documented anywhere.

Change-Id: Ib157edf14e87a6f546c155496f70a760ab218cca
Pick-to: 5.15 5.12
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>

1 files changed, 11 insertions, 3 deletions

diff --git a/src/corelib/tools/qrect.cpp b/src/corelib/tools/qrect.cpp
index 69dc24b5e7..326b0c0cd8 100644
--- a/src/corelib/tools/qrect.cpp
+++ b/src/corelib/tools/qrect.cpp
@@ -2371,8 +2371,13 @@ QRect QRectF::toAlignedRect() const noexcept
     \fn bool operator==(const QRectF &r1, const QRectF &r2)
     \relates QRectF
 
-    Returns \c true if the rectangles \a r1 and \a r2 are equal,
+    Returns \c true if the rectangles \a r1 and \a r2 are \b approximately equal,
     otherwise returns \c false.
+
+    \warning This function does not check for strict equality; instead,
+    it uses a fuzzy comparison to compare the rectangles' coordinates.
+
+    \sa qFuzzyCompare
 */
 
 
@@ -2380,8 +2385,11 @@ QRect QRectF::toAlignedRect() const noexcept
     \fn bool operator!=(const QRectF &r1, const QRectF &r2)
     \relates QRectF
 
-    Returns \c true if the rectangles \a r1 and \a r2 are different, otherwise
-    returns \c false.
+    Returns \c true if the rectangles \a r1 and \a r2 are sufficiently
+    different, otherwise returns \c false.
+
+    \warning This function does not check for strict inequality; instead,
+    it uses a fuzzy comparison to compare the rectangles' coordinates.
 */
 
 /*!