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>
This commit is contained in:
Bradley T. Hughes 2012-03-26 14:47:12 +02:00 committed by Qt by Nokia
parent c95fc3c3b1
commit 798ccb30cf

View File

@ -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