summaryrefslogtreecommitdiff
path: root/src/corelib/kernel/qabstracteventdispatcher.cpp
diff options
context:
space:
mode:
authorBradley T. Hughes <bradley.hughes@nokia.com>2012-03-26 14:47:12 +0200
committerQt by Nokia <qt-info@nokia.com>2012-03-27 19:26:45 +0200
commit798ccb30cfdbdd4b9d6febe3d66ade54dd36112f (patch)
tree495c5ffdddc44abe62c8e851e95be5c7aaa315f1 /src/corelib/kernel/qabstracteventdispatcher.cpp
parentc95fc3c3b1fdad5e75fe1c093f41fd54f8828ca4 (diff)
downloadqtbase-798ccb30cfdbdd4b9d6febe3d66ade54dd36112f.tar.gz
Update documentation for QAbstractEventDispatcher::TimerInfo
This type is not a typedef anymore, it's a proper class. Change-Id: I611df067f2983baf262d84a82fb98e61124956d2 Reviewed-by: Robin Burchell <robin+qt@viroteck.net> Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
Diffstat (limited to 'src/corelib/kernel/qabstracteventdispatcher.cpp')
-rw-r--r--src/corelib/kernel/qabstracteventdispatcher.cpp31
1 files changed, 27 insertions, 4 deletions
diff --git a/src/corelib/kernel/qabstracteventdispatcher.cpp b/src/corelib/kernel/qabstracteventdispatcher.cpp
index b98f3f4a30..9d76aa610f 100644
--- a/src/corelib/kernel/qabstracteventdispatcher.cpp
+++ b/src/corelib/kernel/qabstracteventdispatcher.cpp
@@ -327,14 +327,37 @@ void QAbstractEventDispatcher::closingDown()
{ }
/*!
- \typedef QAbstractEventDispatcher::TimerInfo
+ \class QAbstractEventDispatcher::TimerInfo
- Typedef for QPair<int, int>. The first component of
- the pair is the timer ID; the second component is
- the interval.
+ This struct represents information about a timer:
+ \l{QAbstractEventDispatcher::TimerInfo::timerId}{timerId},
+ \l{QAbstractEventDispatcher::TimerInfo::interval}{interval}, and
+ \l{QAbstractEventDispatcher::TimerInfo::timerType}{timerType}.
\sa registeredTimers()
*/
+/*! \fn QAbstractEventDispatcher::TimerInfo::TimerInfo(int timerId, int interval, Qt::TimerType timerType)
+
+ Constructs a TimerInfo struct with the given \a timerId, \a interval, and
+ \a timerType.
+*/
+/*!
+ \variable QAbstractEventDispatcher::TimerInfo::timerId
+
+ The timer's unique id.
+*/
+/*!
+ \variable QAbstractEventDispatcher::TimerInfo::interval
+
+ The timer's interval.
+*/
+/*!
+ \variable QAbstractEventDispatcher::TimerInfo::timerType
+
+ The timer's type
+
+ \sa Qt::TimerType
+*/
/*!
\typedef QAbstractEventDispatcher::EventFilter