Added documentation for qmath.h header and qnumeric.h.

Reviewed by: David Boddie
Tasks:  QTBUG-10011,    QTBUG-3205

1 files changed, 35 insertions, 0 deletions

diff --git a/src/corelib/global/qnumeric.cpp b/src/corelib/global/qnumeric.cpp
index 75fd31e..7ddb9e2 100644
--- a/src/corelib/global/qnumeric.cpp
+++ b/src/corelib/global/qnumeric.cpp
@@ -44,14 +44,49 @@
 
 QT_BEGIN_NAMESPACE
 
+/*!
+    Returns true if the double \a {d} is equivalent to infinity.
+*/
 Q_CORE_EXPORT bool qIsInf(double d) { return qt_is_inf(d); }
+
+/*!
+    Returns true if the double \a {d} is not a number (NaN).
+*/
 Q_CORE_EXPORT bool qIsNaN(double d) { return qt_is_nan(d); }
+
+/*!
+    Returns true if the double \a {d} is a finite number.
+*/
 Q_CORE_EXPORT bool qIsFinite(double d) { return qt_is_finite(d); }
+
+/*!
+    Returns true if the float \a {f} is equivalent to infinity.
+*/
 Q_CORE_EXPORT bool qIsInf(float f) { return qt_is_inf(f); }
+
+/*!
+    Returns true if the float \a {f} is not a number (NaN).
+*/
 Q_CORE_EXPORT bool qIsNaN(float f) { return qt_is_nan(f); }
+
+/*!
+    Returns true if the float \a {f} is a finite number.
+*/
 Q_CORE_EXPORT bool qIsFinite(float f) { return qt_is_finite(f); }
+
+/*!
+    Returns the bit pattern of a signalling NaN as a double.
+*/
 Q_CORE_EXPORT double qSNaN() { return qt_snan(); }
+
+/*!
+    Returns the bit pattern of a quiet NaN as a double.
+*/
 Q_CORE_EXPORT double qQNaN() { return qt_qnan(); }
+
+/*!
+    Returns the bit pattern for an infinite number as a double.
+*/
 Q_CORE_EXPORT double qInf() { return qt_inf(); }