qdoc: Documentation for qFuzzyIsNull() is added

The two versions of this function are now documented on the
global variables page.

Change-Id: Iee95e251d616f6c8b1b42458d23cbf64a70a5315
Task-number: QTBUG-50654
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
bb10
Martin Smith 2016-02-01 13:47:13 +01:00 committed by Robin Burchell
parent 205ff27260
commit 4038c07e5f
2 changed files with 18 additions and 6 deletions

View File

@ -4246,6 +4246,24 @@ bool QInternal::activateCallbacks(Callback cb, void **parameters)
exactness is stronger the smaller the numbers are.
*/
/*!
\fn bool qFuzzyIsNull(double d)
\relates <QtGlobal>
\since 4.4
\threadsafe
Returns true if the absolute value of \a d is within 0.000000000001 of 0.0.
*/
/*!
\fn bool qFuzzyIsNull(float f)
\relates <QtGlobal>
\since 4.4
\threadsafe
Returns true if the absolute value of \a f is within 0.00001f of 0.0.
*/
/*!
\macro QT_REQUIRE_VERSION(int argc, char **argv, const char *version)
\relates <QtGlobal>

View File

@ -771,18 +771,12 @@ Q_DECL_CONSTEXPR static inline bool qFuzzyCompare(float p1, float p2)
return (qAbs(p1 - p2) * 100000.f <= qMin(qAbs(p1), qAbs(p2)));
}
/*!
\internal
*/
Q_DECL_CONSTEXPR static inline bool qFuzzyIsNull(double d) Q_REQUIRED_RESULT Q_DECL_UNUSED;
Q_DECL_CONSTEXPR static inline bool qFuzzyIsNull(double d)
{
return qAbs(d) <= 0.000000000001;
}
/*!
\internal
*/
Q_DECL_CONSTEXPR static inline bool qFuzzyIsNull(float f) Q_REQUIRED_RESULT Q_DECL_UNUSED;
Q_DECL_CONSTEXPR static inline bool qFuzzyIsNull(float f)
{