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>

1 files changed, 37 insertions, 37 deletions

diff --git a/src/corelib/io/qdir.cpp b/src/corelib/io/qdir.cpp
index 5af398c360..ed3c4d6993 100644
--- a/src/corelib/io/qdir.cpp
+++ b/src/corelib/io/qdir.cpp
@@ -855,8 +855,8 @@ QString QDir::fromNativeSeparators(const QString &pathName)
 /*!
     Changes the QDir's directory to \a dirName.
 
-    Returns true if the new directory exists and is readable;
-    otherwise returns false. Note that the logical cd() operation is
+    Returns \c true if the new directory exists and is readable;
+    otherwise returns \c false. Note that the logical cd() operation is
     not performed if the new directory does not exist.
 
     Calling cd("..") is equivalent to calling cdUp().
@@ -923,8 +923,8 @@ bool QDir::cd(const QString &dirName)
     Changes directory by moving one directory up from the QDir's
     current directory.
 
-    Returns true if the new directory exists and is readable;
-    otherwise returns false. Note that the logical cdUp() operation is
+    Returns \c true if the new directory exists and is readable;
+    otherwise returns \c false. Note that the logical cdUp() operation is
     not performed if the new directory does not exist.
 
     \sa cd(), isReadable(), exists(), path()
@@ -1373,7 +1373,7 @@ QFileInfoList QDir::entryInfoList(const QStringList &nameFilters, Filters filter
 /*!
     Creates a sub-directory called \a dirName.
 
-    Returns true on success; otherwise returns false.
+    Returns \c true on success; otherwise returns \c false.
 
     If the directory already exists when this function is called, it will return false.
 
@@ -1399,7 +1399,7 @@ bool QDir::mkdir(const QString &dirName) const
 
     The directory must be empty for rmdir() to succeed.
 
-    Returns true if successful; otherwise returns false.
+    Returns \c true if successful; otherwise returns \c false.
 
     \sa mkdir()
 */
@@ -1425,7 +1425,7 @@ bool QDir::rmdir(const QString &dirName) const
     The function will create all parent directories necessary to
     create the directory.
 
-    Returns true if successful; otherwise returns false.
+    Returns \c true if successful; otherwise returns \c false.
 
     If the path already exists when this function is called, it will return true.
 
@@ -1453,7 +1453,7 @@ bool QDir::mkpath(const QString &dirPath) const
     provided that they are empty. This is the opposite of
     mkpath(dirPath).
 
-    Returns true if successful; otherwise returns false.
+    Returns \c true if successful; otherwise returns \c false.
 
     \sa mkpath()
 */
@@ -1476,13 +1476,13 @@ bool QDir::rmpath(const QString &dirPath) const
     \since 5.0
     Removes the directory, including all its contents.
 
-    Returns true if successful, otherwise false.
+    Returns \c true if successful, otherwise false.
 
     If a file or directory cannot be removed, removeRecursively() keeps going
     and attempts to delete as many files and sub-directories as possible,
-    then returns false.
+    then returns \c false.
 
-    If the directory was already removed, the method returns true
+    If the directory was already removed, the method returns \c true
     (expected result already reached).
 
     Note: this function is meant for removing a small application-internal
@@ -1520,8 +1520,8 @@ bool QDir::removeRecursively()
 }
 
 /*!
-    Returns true if the directory is readable \e and we can open files
-    by name; otherwise returns false.
+    Returns \c true if the directory is readable \e and we can open files
+    by name; otherwise returns \c false.
 
     \warning A false value from this function is not a guarantee that
     files in the directory are not accessible.
@@ -1550,7 +1550,7 @@ bool QDir::isReadable() const
 /*!
     \overload
 
-    Returns true if the directory exists; otherwise returns false.
+    Returns \c true if the directory exists; otherwise returns \c false.
     (If a file with the same name is found this function will return false).
 
     The overload of this function that accepts an argument is used to test
@@ -1564,11 +1564,11 @@ bool QDir::exists() const
 }
 
 /*!
-    Returns true if the directory is the root directory; otherwise
-    returns false.
+    Returns \c true if the directory is the root directory; otherwise
+    returns \c false.
 
     Note: If the directory is a symbolic link to the root directory
-    this function returns false. If you want to test for this use
+    this function returns \c false. If you want to test for this use
     canonicalPath(), e.g.
 
     \snippet code/src_corelib_io_qdir.cpp 9
@@ -1585,8 +1585,8 @@ bool QDir::isRoot() const
 /*!
     \fn bool QDir::isAbsolute() const
 
-    Returns true if the directory's path is absolute; otherwise
-    returns false. See isAbsolutePath().
+    Returns \c true if the directory's path is absolute; otherwise
+    returns \c false. See isAbsolutePath().
 
     \sa isRelative(), makeAbsolute(), cleanPath()
 */
@@ -1594,14 +1594,14 @@ bool QDir::isRoot() const
 /*!
    \fn bool QDir::isAbsolutePath(const QString &)
 
-    Returns true if \a path is absolute; returns false if it is
+    Returns \c true if \a path is absolute; returns \c false if it is
     relative.
 
     \sa isAbsolute(), isRelativePath(), makeAbsolute(), cleanPath()
 */
 
 /*!
-    Returns true if the directory path is relative; otherwise returns
+    Returns \c true if the directory path is relative; otherwise returns
     false. (Under Unix a path is relative if it does not start with a
     "/").
 
@@ -1617,8 +1617,8 @@ bool QDir::isRelative() const
 
 /*!
     Converts the directory path to an absolute path. If it is already
-    absolute nothing happens. Returns true if the conversion
-    succeeded; otherwise returns false.
+    absolute nothing happens. Returns \c true if the conversion
+    succeeded; otherwise returns \c false.
 
     \sa isAbsolute(), isAbsolutePath(), isRelative(), cleanPath()
 */
@@ -1643,9 +1643,9 @@ bool QDir::makeAbsolute()
 }
 
 /*!
-    Returns true if directory \a dir and this directory have the same
+    Returns \c true if directory \a dir and this directory have the same
     path and their sort and filter settings are the same; otherwise
-    returns false.
+    returns \c false.
 
     Example:
 
@@ -1730,7 +1730,7 @@ QDir &QDir::operator=(const QString &path)
 /*!
     \fn bool QDir::operator!=(const QDir &dir) const
 
-    Returns true if directory \a dir and this directory have different
+    Returns \c true if directory \a dir and this directory have different
     paths or different sort or filter settings; otherwise returns
     false.
 
@@ -1742,8 +1742,8 @@ QDir &QDir::operator=(const QString &path)
 /*!
     Removes the file, \a fileName.
 
-    Returns true if the file is removed successfully; otherwise
-    returns false.
+    Returns \c true if the file is removed successfully; otherwise
+    returns \c false.
 */
 bool QDir::remove(const QString &fileName)
 {
@@ -1756,7 +1756,7 @@ bool QDir::remove(const QString &fileName)
 
 /*!
     Renames a file or directory from \a oldName to \a newName, and returns
-    true if successful; otherwise returns false.
+    true if successful; otherwise returns \c false.
 
     On most file systems, rename() fails only if \a oldName does not
     exist, or if a file with the new name already exists.
@@ -1784,7 +1784,7 @@ bool QDir::rename(const QString &oldName, const QString &newName)
 }
 
 /*!
-    Returns true if the file called \a name exists; otherwise returns
+    Returns \c true if the file called \a name exists; otherwise returns
     false.
 
     Unless \a name contains an absolute file path, the file name is assumed
@@ -1841,8 +1841,8 @@ QChar QDir::separator()
 
 /*!
     Sets the application's current working directory to \a path.
-    Returns true if the directory was successfully changed; otherwise
-    returns false.
+    Returns \c true if the directory was successfully changed; otherwise
+    returns \c false.
 
     \sa current(), currentPath(), home(), root(), temp()
 */
@@ -1980,8 +1980,8 @@ QString QDir::rootPath()
 /*!
     \overload
 
-    Returns true if the \a fileName matches any of the wildcard (glob)
-    patterns in the list of \a filters; otherwise returns false. The
+    Returns \c true if the \a fileName matches any of the wildcard (glob)
+    patterns in the list of \a filters; otherwise returns \c false. The
     matching is case insensitive.
 
     \sa {QRegExp wildcard matching}, QRegExp::exactMatch(), entryList(), entryInfoList()
@@ -1997,8 +1997,8 @@ bool QDir::match(const QStringList &filters, const QString &fileName)
 }
 
 /*!
-    Returns true if the \a fileName matches the wildcard (glob)
-    pattern \a filter; otherwise returns false. The \a filter may
+    Returns \c true if the \a fileName matches the wildcard (glob)
+    pattern \a filter; otherwise returns \c false. The \a filter may
     contain multiple patterns separated by spaces or semicolons.
     The matching is case insensitive.
 
@@ -2159,7 +2159,7 @@ QString QDir::cleanPath(const QString &path)
 }
 
 /*!
-    Returns true if \a path is relative; returns false if it is
+    Returns \c true if \a path is relative; returns \c false if it is
     absolute.
 
     \sa isRelative(), isAbsolutePath(), makeAbsolute()