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/qsessionmanager.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/qsessionmanager.cpp')
-rw-r--r-- | src/gui/kernel/qsessionmanager.cpp | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/gui/kernel/qsessionmanager.cpp b/src/gui/kernel/qsessionmanager.cpp index c46dd5f55a..b9ef35854c 100644 --- a/src/gui/kernel/qsessionmanager.cpp +++ b/src/gui/kernel/qsessionmanager.cpp @@ -181,7 +181,7 @@ QString QSessionManager::sessionKey() const /*! Asks the session manager for permission to interact with the user. Returns - true if interaction is permitted; otherwise returns false. + true if interaction is permitted; otherwise returns \c false. The rationale behind this mechanism is to make it possible to synchronize user interaction during a shutdown. Advanced session managers may ask all @@ -215,7 +215,7 @@ bool QSessionManager::allowsInteraction() } /*! - Returns true if error interaction is permitted; otherwise returns false. + Returns \c true if error interaction is permitted; otherwise returns \c false. This is similar to allowsInteraction(), but also enables the application to tell the user about any errors that occur. Session managers may give error @@ -386,8 +386,8 @@ void QSessionManager::setManagerProperty(const QString &name, } /*! - Returns true if the session manager is currently performing a second - session management phase; otherwise returns false. + Returns \c true if the session manager is currently performing a second + session management phase; otherwise returns \c false. \sa requestPhase2() */ |