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/gui/kernel/qguiapplication.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/gui/kernel/qguiapplication.cpp')
-rw-r--r-- | src/gui/kernel/qguiapplication.cpp | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/src/gui/kernel/qguiapplication.cpp b/src/gui/kernel/qguiapplication.cpp index c7eefdbefa..47efc98474 100644 --- a/src/gui/kernel/qguiapplication.cpp +++ b/src/gui/kernel/qguiapplication.cpp @@ -645,7 +645,7 @@ void QGuiApplicationPrivate::hideModalWindow(QWindow *window) } /* - Returns true if \a window is blocked by a modal window. If \a + Returns \c true if \a window is blocked by a modal window. If \a blockingWindow is non-zero, *blockingWindow will be set to the blocking window (or to zero if \a window is not blocked). */ @@ -2520,8 +2520,8 @@ void QGuiApplication::setFont(const QFont &font) /*! \fn bool QGuiApplication::isRightToLeft() - Returns true if the application's layout direction is - Qt::RightToLeft; otherwise returns false. + Returns \c true if the application's layout direction is + Qt::RightToLeft; otherwise returns \c false. \sa layoutDirection(), isLeftToRight() */ @@ -2529,8 +2529,8 @@ void QGuiApplication::setFont(const QFont &font) /*! \fn bool QGuiApplication::isLeftToRight() - Returns true if the application's layout direction is - Qt::LeftToRight; otherwise returns false. + Returns \c true if the application's layout direction is + Qt::LeftToRight; otherwise returns \c false. \sa layoutDirection(), isRightToLeft() */ @@ -2552,7 +2552,7 @@ void QGuiApplicationPrivate::notifyActiveWindowChange(QWindow *) The default is true. - If this property is true, the applications quits when the last visible + If this property is \c true, the applications quits when the last visible primary window (i.e. window with no parent) is closed. \sa quit(), QWindow::close() @@ -2720,8 +2720,8 @@ void QGuiApplicationPrivate::setApplicationState(Qt::ApplicationState state) /*! \fn bool QGuiApplication::isSessionRestored() const - Returns true if the application has been restored from an earlier - \l{Session Management}{session}; otherwise returns false. + Returns \c true if the application has been restored from an earlier + \l{Session Management}{session}; otherwise returns \c false. \sa sessionId(), commitDataRequest(), saveStateRequest() */ @@ -2730,8 +2730,8 @@ void QGuiApplicationPrivate::setApplicationState(Qt::ApplicationState state) \since 5.0 \fn bool QGuiApplication::isSavingSession() const - Returns true if the application is currently saving the - \l{Session Management}{session}; otherwise returns false. + Returns \c true if the application is currently saving the + \l{Session Management}{session}; otherwise returns \c false. This is true when commitDataRequest() and saveStateRequest() are emitted, but also when the windows are closed afterwards by session management. @@ -3013,8 +3013,8 @@ void QGuiApplication::setDesktopSettingsAware(bool on) } /*! - Returns true if Qt is set to use the system's standard colors, fonts, etc.; - otherwise returns false. The default is true. + Returns \c true if Qt is set to use the system's standard colors, fonts, etc.; + otherwise returns \c false. The default is true. \sa setDesktopSettingsAware() */ |