Document that QBasicTimer::start(int, QObject*) uses Qt::CoarseTimer

Change-Id: I553b33ac7adffb0a4fcdfc14d6e34b4e7a494c4d
Reviewed-by: David Faure <faure@kde.org>
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Reviewed-by: Robin Burchell <robin+qt@viroteck.net>

diff --git a/src/corelib/kernel/qbasictimer.cpp b/src/corelib/kernel/qbasictimer.cpp
index 617e5e5..a521528 100644 (file)
--- a/src/corelib/kernel/qbasictimer.cpp
+++ b/src/corelib/kernel/qbasictimer.cpp
@@ -106,12 +106,13 @@ QT_BEGIN_NAMESPACE
 /*!
     \fn void QBasicTimer::start(int msec, QObject *object)
 
-    Starts (or restarts) the timer with a \a msec milliseconds
-    timeout.
+    Starts (or restarts) the timer with a \a msec milliseconds timeout. The
+    timer will be a Qt::CoarseTimer. See Qt::TimerType for information on the
+    different timer types.
 
     The given \a object will receive timer events.
 
-    \sa stop() isActive() QObject::timerEvent()
+    \sa stop() isActive() QObject::timerEvent() Qt::CoarseTimer
  */
 void QBasicTimer::start(int msec, QObject *obj)
 {