diff options
author | Jerome Pasion <jerome.pasion@digia.com> | 2013-10-02 16:51:05 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-10-08 00:46:27 +0200 |
commit | 4533cc994484a2308297e64e99af005fb4dca065 (patch) | |
tree | bc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/corelib/kernel/qcoreapplication.cpp | |
parent | 50dd0232b61d8ea3fb9aab18972c6e19678656e6 (diff) |
Doc: Adding mark-up to boolean default values.
Default values should have mark-up to denote that they are code.
This commit changes:
-"property is true" to "property is \c true".
-"Returns true" to "Returns \c true".
-"property is false" to "property is \c false".
-"returns true" to "returns \c true".
-"returns false" to "returns \c false".
src/3rdparty and non-documentation instances were ignored.
Task-number: QTBUG-33360
Change-Id: Ie87eaa57af947caa1230602b61c5c46292a4cf4e
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/corelib/kernel/qcoreapplication.cpp')
-rw-r--r-- | src/corelib/kernel/qcoreapplication.cpp | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/src/corelib/kernel/qcoreapplication.cpp b/src/corelib/kernel/qcoreapplication.cpp index 115f7bc04e..0460c52d1c 100644 --- a/src/corelib/kernel/qcoreapplication.cpp +++ b/src/corelib/kernel/qcoreapplication.cpp @@ -810,8 +810,8 @@ void QCoreApplication::setAttribute(Qt::ApplicationAttribute attribute, bool on) } /*! - Returns true if attribute \a attribute is set; - otherwise returns false. + Returns \c true if attribute \a attribute is set; + otherwise returns \c false. \sa setAttribute() */ @@ -826,15 +826,15 @@ bool QCoreApplication::testAttribute(Qt::ApplicationAttribute attribute) /*! \property QCoreApplication::quitLockEnabled - Returns true if the use of the QEventLoopLocker feature can cause the - application to quit, otherwise returns false. + Returns \c true if the use of the QEventLoopLocker feature can cause the + application to quit, otherwise returns \c false. \sa QEventLoopLocker */ /*! - Returns true if the use of the QEventLoopLocker feature can cause the - application to quit, otherwise returns false. + Returns \c true if the use of the QEventLoopLocker feature can cause the + application to quit, otherwise returns \c false. \sa QEventLoopLocker */ @@ -892,7 +892,7 @@ bool QCoreApplication::notifyInternal(QObject *receiver, QEvent *event) For certain types of events (e.g. mouse and key events), the event will be propagated to the receiver's parent and so on up to the top-level object if the receiver is not interested in the event - (i.e., it returns false). + (i.e., it returns \c false). There are five different ways that events can be processed; reimplementing this virtual function is just one of them. All five @@ -1000,8 +1000,8 @@ bool QCoreApplicationPrivate::notify_helper(QObject *receiver, QEvent * event) } /*! - Returns true if an application object has not been created yet; - otherwise returns false. + Returns \c true if an application object has not been created yet; + otherwise returns \c false. \sa closingDown() */ @@ -1012,8 +1012,8 @@ bool QCoreApplication::startingUp() } /*! - Returns true if the application objects are being destroyed; - otherwise returns false. + Returns \c true if the application objects are being destroyed; + otherwise returns \c false. \sa startingUp() */ @@ -1283,7 +1283,7 @@ void QCoreApplication::postEvent(QObject *receiver, QEvent *event, int priority) /*! \internal - Returns true if \a event was compressed away (possibly deleted) and should not be added to the list. + Returns \c true if \a event was compressed away (possibly deleted) and should not be added to the list. */ bool QCoreApplication::compressEvent(QEvent *event, QObject *receiver, QPostEventList *postedEvents) { @@ -1711,7 +1711,7 @@ void QCoreApplication::quit() generated by Qt Designer provide a \c retranslateUi() function that can be called. - The function returns true on success and false on failure. + The function returns \c true on success and false on failure. \sa removeTranslator(), translate(), QTranslator::load(), {Dynamic Translation} */ @@ -1744,7 +1744,7 @@ bool QCoreApplication::installTranslator(QTranslator *translationFile) translation files used by this application. (It does not delete the translation file from the file system.) - The function returns true on success and false on failure. + The function returns \c true on success and false on failure. \sa installTranslator(), translate(), QObject::tr() */ @@ -2478,8 +2478,8 @@ void QCoreApplication::removeNativeEventFilter(QAbstractNativeEventFilter *filte } /*! - This function returns true if there are pending events; otherwise - returns false. Pending events can be either from the window + This function returns \c true if there are pending events; otherwise + returns \c false. Pending events can be either from the window system or posted events using postEvent(). \sa QAbstractEventDispatcher::hasPendingEvents() |