AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: Fixed autolink errors qtbase/kernel

Browse Source 
Task-number: QTBUG-40362
Change-Id: I54a1111e39fb7e85d34ea97b937d2764d29b27a0
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
This commit is contained in:
Nico Vertriest 2014-08-25 15:56:19 +02:00
parent cf81bf2e2d
commit 0fe2c75273
2 changed files with 23 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/corelib/kernel/qabstracteventdispatcher.cpp
View File

@ -183,8 +183,8 @@ QAbstractEventDispatcher *QAbstractEventDispatcher::instance(QThread *thread)
otherwise returns \c false. otherwise returns \c false.
This function is especially useful if you have a long running This function is especially useful if you have a long running
operation and want to show its progress without allowing user operation, and want to show its progress without allowing user
input; i.e. by using the QEventLoop::ExcludeUserInputEvents flag. input by using the QEventLoop::ExcludeUserInputEvents flag.
If the QEventLoop::WaitForMoreEvents flag is set in \a flags, the If the QEventLoop::WaitForMoreEvents flag is set in \a flags, the
behavior of this function is as follows: behavior of this function is as follows:
@ -317,7 +317,7 @@ int QAbstractEventDispatcher::registerTimer(int interval, Qt::TimerType timerTyp
/*! /*!
\fn void QAbstractEventDispatcher::interrupt() \fn void QAbstractEventDispatcher::interrupt()
Interrupts event dispatching; i.e. the event dispatcher will Interrupts event dispatching. The event dispatcher will
return from processEvents() as soon as possible. return from processEvents() as soon as possible.
*/ */
@ -379,11 +379,11 @@ void QAbstractEventDispatcher::closingDown()
Installs an event filter \a filterObj for all native event filters Installs an event filter \a filterObj for all native event filters
received by the application. received by the application.
The event filter \a filterObj receives events via its nativeEventFilter() The event filter \a filterObj receives events via its \l {QAbstractNativeEventFilter::}{nativeEventFilter()}
function, which is called for all events received by all threads. function, which is called for all events received by all threads.
The nativeEventFilter() function should return true if the event should The \l {QAbstractNativeEventFilter::}{nativeEventFilter()} function should return true
be filtered, (i.e. stopped). It should return false to allow if the event should be filtered, (in this case, stopped). It should return false to allow
normal Qt processing to continue: the native event can then be translated normal Qt processing to continue: the native event can then be translated
into a QEvent and handled by the standard Qt \l{QEvent} {event} filtering, into a QEvent and handled by the standard Qt \l{QEvent} {event} filtering,
e.g. QObject::installEventFilter(). e.g. QObject::installEventFilter().
@ -392,7 +392,7 @@ void QAbstractEventDispatcher::closingDown()
is activated first. is activated first.
\note The filter function set here receives native messages, \note The filter function set here receives native messages,
i.e. MSG or XEvent structs. that is, MSG or XEvent structs.
For maximum portability, you should always try to use QEvents For maximum portability, you should always try to use QEvents
and QObject::installEventFilter() whenever possible. and QObject::installEventFilter() whenever possible.
@ -418,8 +418,8 @@ void QAbstractEventDispatcher::installNativeEventFilter(QAbstractNativeEventFilt
All event filters for this object are automatically removed when All event filters for this object are automatically removed when
this object is destroyed. this object is destroyed.
It is always safe to remove an event filter, even during event It is always safe to remove an event filter, even during event filter
filter activation (i.e. from the nativeEventFilter() function). filter activation (that is, even from within the \l {QAbstractNativeEventFilter::}{nativeEventFilter()} function).
\sa installNativeEventFilter(), QAbstractNativeEventFilter \sa installNativeEventFilter(), QAbstractNativeEventFilter
\since 5.0 \since 5.0

29
src/corelib/kernel/qcoreapplication.cpp
View File

@ -956,8 +956,8 @@ bool QCoreApplication::notifyInternal(QObject *receiver, QEvent *event)
reimplementing this virtual function is just one of them. All five reimplementing this virtual function is just one of them. All five
approaches are listed below: approaches are listed below:
\list 1 \list 1
\li Reimplementing paintEvent(), mousePressEvent() and so \li Reimplementing \l {QWidget::}{paintEvent()}, \l {QWidget::}{mousePressEvent()} and so
on. This is the commonest, easiest and least powerful way. on. This is the commonest, easiest, and least powerful way.
\li Reimplementing this function. This is very powerful, providing \li Reimplementing this function. This is very powerful, providing
complete control; but only one subclass can be active at a time. complete control; but only one subclass can be active at a time.
@ -1154,7 +1154,7 @@ void QCoreApplication::processEvents(QEventLoop::ProcessEventsFlags flags, int m
main event loop receives events from the window system and main event loop receives events from the window system and
dispatches these to the application widgets. dispatches these to the application widgets.
To make your application perform idle processing (i.e. executing a To make your application perform idle processing (by executing a
special function whenever there are no pending events), use a special function whenever there are no pending events), use a
QTimer with 0 timeout. More advanced idle processing schemes can QTimer with 0 timeout. More advanced idle processing schemes can
be achieved using processEvents(). be achieved using processEvents().
@ -1162,11 +1162,11 @@ void QCoreApplication::processEvents(QEventLoop::ProcessEventsFlags flags, int m
We recommend that you connect clean-up code to the We recommend that you connect clean-up code to the
\l{QCoreApplication::}{aboutToQuit()} signal, instead of putting it in \l{QCoreApplication::}{aboutToQuit()} signal, instead of putting it in
your application's \c{main()} function because on some platforms the your application's \c{main()} function because on some platforms the
QCoreApplication::exec() call may not return. For example, on Windows exec() call may not return. For example, on Windows
when the user logs off, the system terminates the process after Qt when the user logs off, the system terminates the process after Qt
closes all top-level windows. Hence, there is no guarantee that the closes all top-level windows. Hence, there is no guarantee that the
application will have time to exit its event loop and execute code at application will have time to exit its event loop and execute code at
the end of the \c{main()} function after the QCoreApplication::exec() the end of the \c{main()} function after the exec()
call. call.
\sa quit(), exit(), processEvents(), QApplication::exec() \sa quit(), exit(), processEvents(), QApplication::exec()
@ -2215,7 +2215,7 @@ QStringList QCoreApplication::arguments()
using the empty constructor. This saves having to repeat this using the empty constructor. This saves having to repeat this
information each time a QSettings object is created. information each time a QSettings object is created.
On Mac, QSettings uses organizationDomain() as the organization On Mac, QSettings uses \l {QCoreApplication::}{organizationDomain()} as the organization
if it's not an empty string; otherwise it uses if it's not an empty string; otherwise it uses
organizationName(). On all other platforms, QSettings uses organizationName(). On all other platforms, QSettings uses
organizationName() as the organization. organizationName() as the organization.
@ -2518,10 +2518,10 @@ void QCoreApplication::removeLibraryPath(const QString &path)
Installs an event filter \a filterObj for all native events Installs an event filter \a filterObj for all native events
received by the application in the main thread. received by the application in the main thread.
The event filter \a filterObj receives events via its nativeEventFilter() The event filter \a filterObj receives events via its \l {QAbstractNativeEventFilter::}{nativeEventFilter()}
function, which is called for all native events received in the main thread. function, which is called for all native events received in the main thread.
The nativeEventFilter() function should return true if the event should The QAbstractNativeEventFilter::nativeEventFilter() function should return true if the event should
be filtered, (i.e. stopped). It should return false to allow be filtered, (i.e. stopped). It should return false to allow
normal Qt processing to continue: the native event can then be translated normal Qt processing to continue: the native event can then be translated
into a QEvent and handled by the standard Qt \l{QEvent} {event} filtering, into a QEvent and handled by the standard Qt \l{QEvent} {event} filtering,
@ -2665,13 +2665,12 @@ void QCoreApplication::setEventDispatcher(QAbstractEventDispatcher *eventDispatc
\snippet code/src_corelib_kernel_qcoreapplication.cpp 4 \snippet code/src_corelib_kernel_qcoreapplication.cpp 4
Note that for an application- or module-wide cleanup, Note that for an application- or module-wide cleanup, qaddPostRoutine()
qAddPostRoutine() is often not suitable. For example, if the is often not suitable. For example, if the program is split into dynamically
program is split into dynamically loaded modules, the relevant loaded modules, the relevant module may be unloaded long before the
module may be unloaded long before the QCoreApplication destructor is QCoreApplication destructor is called. In such cases, if using qaddPostRoutine()
called. In such cases, if using qAddPostRoutine() is still desirable, is still desirable, qRemovePostRoutine() can be used to prevent a routine
qRemovePostRoutine() can be used to prevent a routine from being from being called by the QCoreApplication destructor. For example, if that
called by the QCoreApplication destructor. For example, if that
routine was called before the module was unloaded. routine was called before the module was unloaded.
For modules and libraries, using a reference-counted For modules and libraries, using a reference-counted