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/kernel/qmath.qdoc | |
| 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/kernel/qmath.qdoc')
| -rw-r--r-- | src/corelib/kernel/qmath.qdoc | 2 |
1 files changed, 2 insertions, 0 deletions
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> */ /*! |