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/corelib/io/qtemporarydir.cpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'src/corelib/io/qtemporarydir.cpp') diff --git a/src/corelib/io/qtemporarydir.cpp b/src/corelib/io/qtemporarydir.cpp index f21403d7f1..483a76fa82 100644 --- a/src/corelib/io/qtemporarydir.cpp +++ b/src/corelib/io/qtemporarydir.cpp @@ -242,7 +242,7 @@ QTemporaryDir::~QTemporaryDir() } /*! - Returns true if the QTemporaryDir was created successfully. + Returns \c true if the QTemporaryDir was created successfully. */ bool QTemporaryDir::isValid() const { @@ -259,7 +259,7 @@ QString QTemporaryDir::path() const } /*! - Returns true if the QTemporaryDir is in auto remove + Returns \c true if the QTemporaryDir is in auto remove mode. Auto-remove mode will automatically delete the directory from disk upon destruction. This makes it very easy to create your QTemporaryDir object on the stack, fill it with files, do something with @@ -290,7 +290,7 @@ void QTemporaryDir::setAutoRemove(bool b) /*! Removes the temporary directory, including all its contents. - Returns true if removing was successful. + Returns \c true if removing was successful. */ bool QTemporaryDir::remove() { -- cgit v1.2.3