diff options
author | Allan Sandfeld Jensen <allan.jensen@digia.com> | 2014-03-25 17:07:24 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-04-15 14:24:13 +0200 |
commit | 3fdf53786f33094771ae067eb0e5bfa9d3459ec7 (patch) | |
tree | c94a0cf5933a651cc23e4c5c05b8ce16d05fee14 /src/corelib/kernel/qmath.qdoc | |
parent | cd46e9d959b6ef5f4d28ed83711fd18d692c07c3 (diff) |
Unite the documentation for qmath.h functions
Some functions in qmath.h was documented under QtMath, and some under
QtCore/qmath.h, the latter does not appear to lead to functional links
in the function list, so we should move them all to QtMath.
Task-number: QTBUG-37799
Change-Id: I3118c65ccbfb2401bdc324dbef2885d4e7d1c8f6
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Diffstat (limited to 'src/corelib/kernel/qmath.qdoc')
-rw-r--r-- | src/corelib/kernel/qmath.qdoc | 95 |
1 files changed, 78 insertions, 17 deletions
diff --git a/src/corelib/kernel/qmath.qdoc b/src/corelib/kernel/qmath.qdoc index 06d8db9277..04dbbb0a3b 100644 --- a/src/corelib/kernel/qmath.qdoc +++ b/src/corelib/kernel/qmath.qdoc @@ -26,10 +26,15 @@ ****************************************************************************/ /*! - \headerfile <QtCore/qmath.h> - \title Math Functions + \headerfile <QtMath> + \title Generic Math Functions \ingroup funclists - \brief The <QtCore/qmath.h> header provides various math functions. + + \brief The <QtMath> header file provides various math functions. + + These functions are partly convenience definitions for basic math operations + not available in the C or Standard Template Libraries. + \pagekeywords math trigonometry qmath floor ceiling absolute sine cosine tangent inverse tan exponent power natural logarithm */ @@ -40,7 +45,7 @@ The ceiling is the smallest integer that is not less than \a v. For example, if \a v is 41.2, then the ceiling is 42. - \relates <QtCore/qmath.h> + \relates <QtMath> \sa qFloor() */ @@ -51,7 +56,7 @@ The floor is the largest integer that is not greater than \a v. For example, if \a v is 41.2, then the floor is 41. - \relates <QtCore/qmath.h> + \relates <QtMath> \sa qCeil() */ @@ -59,14 +64,14 @@ \fn qreal qFabs(qreal v) Returns the absolute value of \a v as a qreal. - \relates <QtCore/qmath.h> + \relates <QtMath> */ /*! \fn qreal qSin(qreal v) Returns the sine of the angle \a v in radians. - \relates <QtCore/qmath.h> + \relates <QtMath> \sa qCos(), qTan() */ @@ -74,7 +79,7 @@ \fn qreal qCos(qreal v) Returns the cosine of an angle \a v in radians. - \relates <QtCore/qmath.h> + \relates <QtMath> \sa qSin(), qTan() */ @@ -82,7 +87,7 @@ \fn qreal qTan(qreal v) Returns the tangent of an angle \a v in radians. - \relates <QtCore/qmath.h> + \relates <QtMath> \sa qSin(), qCos() */ @@ -91,7 +96,7 @@ Returns the arccosine of \a v as an angle in radians. Arccosine is the inverse operation of cosine. - \relates <QtCore/qmath.h> + \relates <QtMath> \sa qAtan(), qAsin(), qCos() */ @@ -100,7 +105,7 @@ Returns the arcsine of \a v as an angle in radians. Arcsine is the inverse operation of sine. - \relates <QtCore/qmath.h> + \relates <QtMath> \sa qSin(), qAtan(), qAcos() */ @@ -109,7 +114,7 @@ Returns the arctangent of \a v as an angle in radians. Arctangent is the inverse operation of tangent. - \relates <QtCore/qmath.h> + \relates <QtMath> \sa qTan(), qAcos(), qAsin() */ @@ -118,7 +123,7 @@ Returns the arctangent of a point specified by the coordinates \a y and \a x. This function will return the angle (argument) of that point. - \relates <QtCore/qmath.h> + \relates <QtMath> \sa qAtan() */ @@ -127,7 +132,7 @@ Returns the square root of \a v. This function returns a NaN if \a v is a negative number. - \relates <QtCore/qmath.h> + \relates <QtMath> \sa qPow() */ @@ -135,7 +140,7 @@ \fn qreal qLn(qreal v) Returns the natural logarithm of \a v. Natural logarithm uses base e. - \relates <QtCore/qmath.h> + \relates <QtMath> \sa qExp() */ @@ -143,7 +148,7 @@ \fn qreal qExp(qreal v) Returns the exponential function of \c e to the power of \a v. - \relates <QtCore/qmath.h> + \relates <QtMath> \sa qLn() */ @@ -152,6 +157,62 @@ Returns the value of \a x raised to the power of \a y. That is, \a x is the base and \a y is the exponent. - \relates <QtCore/qmath.h> + \relates <QtMath> \sa qSqrt() */ + +/*! + \fn float qDegreesToRadians(float degrees) + \relates <QtMath> + \since 5.1 + + This function converts the \a degrees in float to radians. + + Example: + + \snippet code/src_corelib_kernel_qmath.cpp 0 + + \sa qRadiansToDegrees() +*/ + +/*! + \fn double qDegreesToRadians(double degrees) + \relates <QtMath> + \since 5.1 + + This function converts the \a degrees in double to radians. + + Example: + + \snippet code/src_corelib_kernel_qmath.cpp 1 + + \sa qRadiansToDegrees() +*/ + +/*! + \fn float qRadiansToDegrees(float radians) + \relates <QtMath> + \since 5.1 + + This function converts the \a radians in float to degrees. + + Example: + + \snippet code/src_corelib_kernel_qmath.cpp 2 + + \sa qDegreesToRadians() +*/ + +/*! + \fn double qRadiansToDegrees(double radians) + \relates <QtMath> + \since 5.1 + + This function converts the \a radians in double to degrees. + + Example: + + \snippet code/src_corelib_kernel_qmath.cpp 3 + + \sa qDegreesToRadians() +*/ |