diff options
author | Martin Smith <martin.smith@nokia.com> | 2012-08-17 11:31:23 +0200 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-08-21 11:05:20 +0200 |
commit | 194b62fb38a9cad1fcb9bc18389707315e0215be (patch) | |
tree | 5c1bd2853dc10d939a3170cab8532853eb60ac71 /src/corelib | |
parent | adc4a8e42bcb4c40314c7f549bc475ba01957b8d (diff) |
doc: Added \relates command to some function qdoc comments
When a documented function is global, it must be related
to a namespace or class, or its documentation won't be
included anywhere.
When a documented function is a class member, the function
signature in the \fn command must include the class name
qualifier, e.g. QImage::isValid(), not just isValid()
Change-Id: I53e2230fa9468f94d51aec8cc76781d7ab755a13
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
Diffstat (limited to 'src/corelib')
-rw-r--r-- | src/corelib/global/qnumeric.cpp | 9 | ||||
-rw-r--r-- | src/corelib/kernel/qmath.qdoc | 2 | ||||
-rw-r--r-- | src/corelib/tools/qdatetime.cpp | 2 |
3 files changed, 12 insertions, 1 deletions
diff --git a/src/corelib/global/qnumeric.cpp b/src/corelib/global/qnumeric.cpp index 1e77231f2f..4c9af445c6 100644 --- a/src/corelib/global/qnumeric.cpp +++ b/src/corelib/global/qnumeric.cpp @@ -46,46 +46,55 @@ QT_BEGIN_NAMESPACE /*! Returns true if the double \a {d} is equivalent to infinity. + \relates <QtGlobal> */ Q_CORE_EXPORT bool qIsInf(double d) { return qt_is_inf(d); } /*! Returns true if the double \a {d} is not a number (NaN). + \relates <QtGlobal> */ Q_CORE_EXPORT bool qIsNaN(double d) { return qt_is_nan(d); } /*! Returns true if the double \a {d} is a finite number. + \relates <QtGlobal> */ Q_CORE_EXPORT bool qIsFinite(double d) { return qt_is_finite(d); } /*! Returns true if the float \a {f} is equivalent to infinity. + \relates <QtGlobal> */ Q_CORE_EXPORT bool qIsInf(float f) { return qt_is_inf(f); } /*! Returns true if the float \a {f} is not a number (NaN). + \relates <QtGlobal> */ Q_CORE_EXPORT bool qIsNaN(float f) { return qt_is_nan(f); } /*! Returns true if the float \a {f} is a finite number. + \relates <QtGlobal> */ Q_CORE_EXPORT bool qIsFinite(float f) { return qt_is_finite(f); } /*! Returns the bit pattern of a signalling NaN as a double. + \relates <QtGlobal> */ Q_CORE_EXPORT double qSNaN() { return qt_snan(); } /*! Returns the bit pattern of a quiet NaN as a double. + \relates <QtGlobal> */ Q_CORE_EXPORT double qQNaN() { return qt_qnan(); } /*! Returns the bit pattern for an infinite number as a double. + \relates <QtGlobal> */ Q_CORE_EXPORT double qInf() { return qt_inf(); } diff --git a/src/corelib/kernel/qmath.qdoc b/src/corelib/kernel/qmath.qdoc index fcc51764b0..cba19a803e 100644 --- a/src/corelib/kernel/qmath.qdoc +++ b/src/corelib/kernel/qmath.qdoc @@ -58,6 +58,8 @@ /*! \fn qreal qFabs(qreal v) Returns the absolute value of \a v as a qreal. + + \relates <QtCore/qmath.h> */ /*! diff --git a/src/corelib/tools/qdatetime.cpp b/src/corelib/tools/qdatetime.cpp index 162117602b..293838e9a5 100644 --- a/src/corelib/tools/qdatetime.cpp +++ b/src/corelib/tools/qdatetime.cpp @@ -275,7 +275,7 @@ QDate::QDate(int y, int m, int d) /*! - \fn bool isValid() const + \fn bool QDate::isValid() const Returns true if this date is valid; otherwise returns false. |