From 4533cc994484a2308297e64e99af005fb4dca065 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 2 Oct 2013 16:51:05 +0200 Subject: 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 Reviewed-by: Jerome Pasion --- src/gui/kernel/qsessionmanager.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'src/gui/kernel/qsessionmanager.cpp') 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() */ -- cgit v1.2.3