From 798ccb30cfdbdd4b9d6febe3d66ade54dd36112f Mon Sep 17 00:00:00 2001 From: "Bradley T. Hughes" Date: Mon, 26 Mar 2012 14:47:12 +0200 Subject: Update documentation for QAbstractEventDispatcher::TimerInfo This type is not a typedef anymore, it's a proper class. Change-Id: I611df067f2983baf262d84a82fb98e61124956d2 Reviewed-by: Robin Burchell Reviewed-by: Casper van Donderen --- src/corelib/kernel/qabstracteventdispatcher.cpp | 31 +++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) (limited to 'src/corelib/kernel/qabstracteventdispatcher.cpp') 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. 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 -- cgit v1.2.3