From e7a607f0f1f7837a26bf95248504497b0534e357 Mon Sep 17 00:00:00 2001
From: Martin Smith <msmith@trolltech.com>
Date: Tue, 26 May 2009 10:19:02 +0200
Subject: qdoc: Indicate that qAbs(T& v) compares v to a 0 of type T.

Task-number: 246789
---
 doc/src/index.qdoc             |  1 +
 src/corelib/global/qglobal.cpp | 49 +++++++++++++++++++++++++++++++-----------
 2 files changed, 38 insertions(+), 12 deletions(-)

diff --git a/doc/src/index.qdoc b/doc/src/index.qdoc
index 4ead9e4..9846ac4 100644
--- a/doc/src/index.qdoc
+++ b/doc/src/index.qdoc
@@ -153,6 +153,7 @@
         <li><a href="overviews.html">All Overviews and HOWTOs</a></li>
         <li><a href="gallery.html">Qt Widget Gallery</a></li>
         <li><a href="http://doc.trolltech.com/extras/qt43-class-chart.pdf">Class Chart</a></li>
+        <li><a href="qtglobal.html">Qt Global Declarations</a></li>
         </ul>
         </td>
         <td valign="top">
diff --git a/src/corelib/global/qglobal.cpp b/src/corelib/global/qglobal.cpp
index 8324d05..f767bb9 100644
--- a/src/corelib/global/qglobal.cpp
+++ b/src/corelib/global/qglobal.cpp
@@ -125,7 +125,8 @@ QT_BEGIN_NAMESPACE
 
     If you want to use QFlags for your own enum types, use
     the Q_DECLARE_FLAGS() and Q_DECLARE_OPERATORS_FOR_FLAGS().
-    For example:
+
+    Example:
 
     \snippet doc/src/snippets/code/src_corelib_global_qglobal.cpp 1
 
@@ -442,14 +443,18 @@ QT_BEGIN_NAMESPACE
     function. You can retrieve the minimum and maximum of two given
     objects using qMin() and qMax() respectively. All these functions
     return a corresponding template type; the template types can be
-    replaced by any other type. For example:
+    replaced by any other type.
+
+    Example:
 
     \snippet doc/src/snippets/code/src_corelib_global_qglobal.cpp 3
 
     <QtGlobal> also contains functions that generate messages from the
     given string argument: qCritical(), qDebug(), qFatal() and
     qWarning(). These functions call the message handler with the
-    given message. For example:
+    given message.
+
+    Example:
 
     \snippet doc/src/snippets/code/src_corelib_global_qglobal.cpp 4
 
@@ -694,7 +699,9 @@ QT_BEGIN_NAMESPACE
     \relates <QtGlobal>
 
     Wraps the signed 64-bit integer \a literal in a
-    platform-independent way. For example:
+    platform-independent way.
+
+    Example:
 
     \snippet doc/src/snippets/code/src_corelib_global_qglobal.cpp 8
 
@@ -705,7 +712,9 @@ QT_BEGIN_NAMESPACE
     \relates <QtGlobal>
 
     Wraps the unsigned 64-bit integer \a literal in a
-    platform-independent way. For example:
+    platform-independent way.
+
+    Example:
 
     \snippet doc/src/snippets/code/src_corelib_global_qglobal.cpp 9
 
@@ -734,7 +743,11 @@ QT_BEGIN_NAMESPACE
 /*! \fn const T &qAbs(const T &value)
     \relates <QtGlobal>
 
-    Returns the absolute value of \a value. For example:
+    Compares \a value to the 0 of type T and returns the absolute
+    value. Thus if T is \e {double}, then \a value is compared to
+    \e{(double) 0}.
+
+    Example:
 
     \snippet doc/src/snippets/code/src_corelib_global_qglobal.cpp 10
 */
@@ -742,7 +755,9 @@ QT_BEGIN_NAMESPACE
 /*! \fn int qRound(qreal value)
     \relates <QtGlobal>
 
-    Rounds \a value to the nearest integer. For example:
+    Rounds \a value to the nearest integer.
+
+    Example:
 
     \snippet doc/src/snippets/code/src_corelib_global_qglobal.cpp 11
 */
@@ -750,7 +765,9 @@ QT_BEGIN_NAMESPACE
 /*! \fn qint64 qRound64(qreal value)
     \relates <QtGlobal>
 
-    Rounds \a value to the nearest 64-bit integer. For example:
+    Rounds \a value to the nearest 64-bit integer.
+
+    Example:
 
     \snippet doc/src/snippets/code/src_corelib_global_qglobal.cpp 12
 */
@@ -758,7 +775,9 @@ QT_BEGIN_NAMESPACE
 /*! \fn const T &qMin(const T &value1, const T &value2)
     \relates <QtGlobal>
 
-    Returns the minimum of \a value1 and \a value2. For example:
+    Returns the minimum of \a value1 and \a value2.
+
+    Example:
 
     \snippet doc/src/snippets/code/src_corelib_global_qglobal.cpp 13
 
@@ -768,7 +787,9 @@ QT_BEGIN_NAMESPACE
 /*! \fn const T &qMax(const T &value1, const T &value2)
     \relates <QtGlobal>
 
-    Returns the maximum of \a value1 and \a value2. For example:
+    Returns the maximum of \a value1 and \a value2.
+
+    Example:
 
     \snippet doc/src/snippets/code/src_corelib_global_qglobal.cpp 14
 
@@ -779,7 +800,9 @@ QT_BEGIN_NAMESPACE
     \relates <QtGlobal>
 
     Returns \a value bounded by \a min and \a max. This is equivalent
-    to qMax(\a min, qMin(\a value, \a max)). For example:
+    to qMax(\a min, qMin(\a value, \a max)).
+
+    Example:
 
     \snippet doc/src/snippets/code/src_corelib_global_qglobal.cpp 15
 
@@ -925,7 +948,9 @@ QT_BEGIN_NAMESPACE
     4.1.2, the QT_VERSION macro will expand to 0x040102.
 
     You can use QT_VERSION to use the latest Qt features where
-    available. For example:
+    available.
+
+    Example:
 
     \snippet doc/src/snippets/code/src_corelib_global_qglobal.cpp 16
 
-- 
cgit v0.12