From 194b62fb38a9cad1fcb9bc18389707315e0215be Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@nokia.com>
Date: Fri, 17 Aug 2012 11:31:23 +0200
Subject: 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>
---
 src/corelib/kernel/qmath.qdoc | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'src/corelib/kernel/qmath.qdoc')

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>
 */
 
 /*!
-- 
cgit v1.2.3