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>
This commit is contained in:
Allan Sandfeld Jensen 2014-03-25 17:07:24 +01:00 committed by The Qt Project
parent cd46e9d959
commit 3fdf53786f
2 changed files with 78 additions and 101 deletions

View File

@ -303,88 +303,4 @@ const qreal qt_sine_table[QT_SINE_TABLE_SIZE] = {
qreal(-0.024541228522912448) qreal(-0.024541228522912448)
}; };
/*!
\headerfile <QtMath>
\title Generic Math Declarations
\ingroup funclists
\brief The <QtMath> header file includes generic math declarations.
These functions are partly convenience definitions for basic
operations, for instance not available in the Standard Template Library et
al.
*/
/*!
\fn float qDegreesToRadians(float degrees)
\relates <QtMath>
\since 5.1
\brief The function converts the \a degrees in float to radians.
The purpose of the function is to aid the conversion as such a convenient
function is not part of the Standard Template Library, i.e. in <cmath> or
elsewhere.
Example:
\snippet code/src_corelib_kernel_qmath.cpp 0
\sa qRadiansToDegrees()
*/
/*!
\fn double qDegreesToRadians(double degrees)
\relates <QtMath>
\since 5.1
\brief The function converts the \a degrees in double to radians.
The purpose of the function is to aid the conversion as such a convenient
function is not part of the Standard Template Library, i.e. in <cmath> or
elsewhere.
Example:
\snippet code/src_corelib_kernel_qmath.cpp 1
\sa qRadiansToDegrees()
*/
/*!
\fn float qRadiansToDegrees(float radians)
\relates <QtMath>
\since 5.1
\brief The function converts the \a radians in float to degrees.
The purpose of the function is to aid the conversion as such a convenient
function is not part of the Standard Template Library, i.e. in <cmath> or
elsewhere.
Example:
\snippet code/src_corelib_kernel_qmath.cpp 2
\sa qDegreesToRadians()
*/
/*!
\fn double qRadiansToDegrees(double radians)
\relates <QtMath>
\since 5.1
\brief The function converts the \a radians in double to degrees.
The purpose of the function is to aid the conversion as such a convenient
function is not part of the Standard Template Library, i.e. in <cmath> or
elsewhere.
Example:
\snippet code/src_corelib_kernel_qmath.cpp 3
\sa qDegreesToRadians()
*/
QT_END_NAMESPACE QT_END_NAMESPACE

View File

@ -26,10 +26,15 @@
****************************************************************************/ ****************************************************************************/
/*! /*!
\headerfile <QtCore/qmath.h> \headerfile <QtMath>
\title Math Functions \title Generic Math Functions
\ingroup funclists \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 \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. 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. For example, if \a v is 41.2, then the ceiling is 42.
\relates <QtCore/qmath.h> \relates <QtMath>
\sa qFloor() \sa qFloor()
*/ */
@ -51,7 +56,7 @@
The floor is the largest integer that is not greater than \a v. 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. For example, if \a v is 41.2, then the floor is 41.
\relates <QtCore/qmath.h> \relates <QtMath>
\sa qCeil() \sa qCeil()
*/ */
@ -59,14 +64,14 @@
\fn qreal qFabs(qreal v) \fn qreal qFabs(qreal v)
Returns the absolute value of \a v as a qreal. Returns the absolute value of \a v as a qreal.
\relates <QtCore/qmath.h> \relates <QtMath>
*/ */
/*! /*!
\fn qreal qSin(qreal v) \fn qreal qSin(qreal v)
Returns the sine of the angle \a v in radians. Returns the sine of the angle \a v in radians.
\relates <QtCore/qmath.h> \relates <QtMath>
\sa qCos(), qTan() \sa qCos(), qTan()
*/ */
@ -74,7 +79,7 @@
\fn qreal qCos(qreal v) \fn qreal qCos(qreal v)
Returns the cosine of an angle \a v in radians. Returns the cosine of an angle \a v in radians.
\relates <QtCore/qmath.h> \relates <QtMath>
\sa qSin(), qTan() \sa qSin(), qTan()
*/ */
@ -82,7 +87,7 @@
\fn qreal qTan(qreal v) \fn qreal qTan(qreal v)
Returns the tangent of an angle \a v in radians. Returns the tangent of an angle \a v in radians.
\relates <QtCore/qmath.h> \relates <QtMath>
\sa qSin(), qCos() \sa qSin(), qCos()
*/ */
@ -91,7 +96,7 @@
Returns the arccosine of \a v as an angle in radians. Returns the arccosine of \a v as an angle in radians.
Arccosine is the inverse operation of cosine. Arccosine is the inverse operation of cosine.
\relates <QtCore/qmath.h> \relates <QtMath>
\sa qAtan(), qAsin(), qCos() \sa qAtan(), qAsin(), qCos()
*/ */
@ -100,7 +105,7 @@
Returns the arcsine of \a v as an angle in radians. Returns the arcsine of \a v as an angle in radians.
Arcsine is the inverse operation of sine. Arcsine is the inverse operation of sine.
\relates <QtCore/qmath.h> \relates <QtMath>
\sa qSin(), qAtan(), qAcos() \sa qSin(), qAtan(), qAcos()
*/ */
@ -109,7 +114,7 @@
Returns the arctangent of \a v as an angle in radians. Returns the arctangent of \a v as an angle in radians.
Arctangent is the inverse operation of tangent. Arctangent is the inverse operation of tangent.
\relates <QtCore/qmath.h> \relates <QtMath>
\sa qTan(), qAcos(), qAsin() \sa qTan(), qAcos(), qAsin()
*/ */
@ -118,7 +123,7 @@
Returns the arctangent of a point specified by the coordinates \a y and \a x. 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. This function will return the angle (argument) of that point.
\relates <QtCore/qmath.h> \relates <QtMath>
\sa qAtan() \sa qAtan()
*/ */
@ -127,7 +132,7 @@
Returns the square root of \a v. Returns the square root of \a v.
This function returns a NaN if \a v is a negative number. This function returns a NaN if \a v is a negative number.
\relates <QtCore/qmath.h> \relates <QtMath>
\sa qPow() \sa qPow()
*/ */
@ -135,7 +140,7 @@
\fn qreal qLn(qreal v) \fn qreal qLn(qreal v)
Returns the natural logarithm of \a v. Natural logarithm uses base e. Returns the natural logarithm of \a v. Natural logarithm uses base e.
\relates <QtCore/qmath.h> \relates <QtMath>
\sa qExp() \sa qExp()
*/ */
@ -143,7 +148,7 @@
\fn qreal qExp(qreal v) \fn qreal qExp(qreal v)
Returns the exponential function of \c e to the power of \a v. Returns the exponential function of \c e to the power of \a v.
\relates <QtCore/qmath.h> \relates <QtMath>
\sa qLn() \sa qLn()
*/ */
@ -152,6 +157,62 @@
Returns the value of \a x raised to the power of \a y. 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. That is, \a x is the base and \a y is the exponent.
\relates <QtCore/qmath.h> \relates <QtMath>
\sa qSqrt() \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()
*/