summaryrefslogtreecommitdiffstats
path: root/src/corelib/io
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2013-10-02 16:51:05 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-08 00:46:27 +0200
commit4533cc994484a2308297e64e99af005fb4dca065 (patch)
treebc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/corelib/io
parent50dd0232b61d8ea3fb9aab18972c6e19678656e6 (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/corelib/io')
-rw-r--r--src/corelib/io/qabstractfileengine.cpp48
-rw-r--r--src/corelib/io/qdatastream.cpp4
-rw-r--r--src/corelib/io/qdebug.cpp2
-rw-r--r--src/corelib/io/qdir.cpp74
-rw-r--r--src/corelib/io/qdiriterator.cpp6
-rw-r--r--src/corelib/io/qfile.cpp56
-rw-r--r--src/corelib/io/qfiledevice.cpp20
-rw-r--r--src/corelib/io/qfileinfo.cpp58
-rw-r--r--src/corelib/io/qfsfileengine.cpp16
-rw-r--r--src/corelib/io/qiodevice.cpp44
-rw-r--r--src/corelib/io/qlockfile.cpp18
-rw-r--r--src/corelib/io/qlockfile_p.h2
-rw-r--r--src/corelib/io/qnoncontiguousbytedevice.cpp4
-rw-r--r--src/corelib/io/qprocess.cpp26
-rw-r--r--src/corelib/io/qresource.cpp24
-rw-r--r--src/corelib/io/qsavefile.cpp6
-rw-r--r--src/corelib/io/qsettings.cpp10
-rw-r--r--src/corelib/io/qstandardpaths.cpp2
-rw-r--r--src/corelib/io/qtemporarydir.cpp6
-rw-r--r--src/corelib/io/qtemporaryfile.cpp2
-rw-r--r--src/corelib/io/qtextstream.cpp20
-rw-r--r--src/corelib/io/qurl.cpp36
-rw-r--r--src/corelib/io/qurlquery.cpp8
-rw-r--r--src/corelib/io/qwindowspipereader.cpp4
24 files changed, 248 insertions, 248 deletions
diff --git a/src/corelib/io/qabstractfileengine.cpp b/src/corelib/io/qabstractfileengine.cpp
index 9cdbbbbb25..a9cb5b5278 100644
--- a/src/corelib/io/qabstractfileengine.cpp
+++ b/src/corelib/io/qabstractfileengine.cpp
@@ -377,8 +377,8 @@ QAbstractFileEngine::~QAbstractFileEngine()
/*!
\fn bool QAbstractFileEngine::open(QIODevice::OpenMode mode)
- Opens the file in the specified \a mode. Returns true if the file
- was successfully opened; otherwise returns false.
+ Opens the file in the specified \a mode. Returns \c true if the file
+ was successfully opened; otherwise returns \c false.
The \a mode is an OR combination of QIODevice::OpenMode and
QIODevice::HandlingMode values.
@@ -390,9 +390,9 @@ bool QAbstractFileEngine::open(QIODevice::OpenMode openMode)
}
/*!
- Closes the file, returning true if successful; otherwise returns false.
+ Closes the file, returning true if successful; otherwise returns \c false.
- The default implementation always returns false.
+ The default implementation always returns \c false.
*/
bool QAbstractFileEngine::close()
{
@@ -404,8 +404,8 @@ bool QAbstractFileEngine::close()
Flushes and syncs the file to disk.
- Returns true if successful; otherwise returns false.
- The default implementation always returns false.
+ Returns \c true if successful; otherwise returns \c false.
+ The default implementation always returns \c false.
*/
bool QAbstractFileEngine::syncToDisk()
{
@@ -416,7 +416,7 @@ bool QAbstractFileEngine::syncToDisk()
Flushes the open file, returning true if successful; otherwise returns
false.
- The default implementation always returns false.
+ The default implementation always returns \c false.
*/
bool QAbstractFileEngine::flush()
{
@@ -444,8 +444,8 @@ qint64 QAbstractFileEngine::pos() const
/*!
\fn bool QAbstractFileEngine::seek(qint64 offset)
- Sets the file position to the given \a offset. Returns true if
- the position was successfully set; otherwise returns false.
+ Sets the file position to the given \a offset. Returns \c true if
+ the position was successfully set; otherwise returns \c false.
The offset is from the beginning of the file, unless the
file is sequential.
@@ -459,7 +459,7 @@ bool QAbstractFileEngine::seek(qint64 pos)
}
/*!
- Returns true if the file is a sequential access device; returns
+ Returns \c true if the file is a sequential access device; returns
false if the file is a direct access device.
Operations involving size() and seek(int) are not valid on
@@ -485,7 +485,7 @@ bool QAbstractFileEngine::remove()
/*!
Copies the contents of this file to a file with the name \a newName.
- Returns true on success; otherwise, false is returned.
+ Returns \c true on success; otherwise, false is returned.
*/
bool QAbstractFileEngine::copy(const QString &newName)
{
@@ -513,7 +513,7 @@ bool QAbstractFileEngine::rename(const QString &newName)
Requests that the file be renamed to \a newName in the file
system. If the new name already exists, it must be overwritten.
- If the operation succeeds, returns true; otherwise returns
+ If the operation succeeds, returns \c true; otherwise returns
false.
This virtual function must be reimplemented by all subclasses.
@@ -530,7 +530,7 @@ bool QAbstractFileEngine::renameOverwrite(const QString &newName)
Creates a link from the file currently specified by fileName() to
\a newName. What a link is depends on the underlying filesystem
(be it a shortcut on Windows or a symbolic link on Unix). Returns
- true if successful; otherwise returns false.
+ true if successful; otherwise returns \c false.
*/
bool QAbstractFileEngine::link(const QString &newName)
{
@@ -772,8 +772,8 @@ int QAbstractFileEngine::handle() const
/*!
\since 4.3
- Returns true if the current position is at the end of the file; otherwise,
- returns false.
+ Returns \c true if the current position is at the end of the file; otherwise,
+ returns \c false.
This function bases its behavior on calling extension() with
AtEndExtension. If the engine does not support this extension, false is
@@ -790,7 +790,7 @@ bool QAbstractFileEngine::atEnd() const
\since 4.4
Maps \a size bytes of the file into memory starting at \a offset.
- Returns a pointer to the memory if successful; otherwise returns false
+ Returns a pointer to the memory if successful; otherwise returns \c false
if, for example, an error occurs.
This function bases its behavior on calling extension() with
@@ -817,8 +817,8 @@ uchar *QAbstractFileEngine::map(qint64 offset, qint64 size, QFile::MemoryMapFlag
/*!
\since 4.4
- Unmaps the memory \a address. Returns true if the unmap succeeds; otherwise
- returns false.
+ Unmaps the memory \a address. Returns \c true if the unmap succeeds; otherwise
+ returns \c false.
This function bases its behavior on calling extension() with
UnMapExtensionOption. If the engine does not support this extension, false is
@@ -867,7 +867,7 @@ bool QAbstractFileEngine::unmap(uchar *address)
You can call dirName() to get the directory name, nameFilters() to get a
stringlist of name filters, and filters() to get the entry filters.
- The pure virtual function hasNext() returns true if the current directory
+ The pure virtual function hasNext() returns \c true if the current directory
has at least one more entry (i.e., the directory name is valid and
accessible, and we have not reached the end of the entry list), and false
otherwise. Reimplement next() to seek to the next entry.
@@ -1056,7 +1056,7 @@ QVariant QAbstractFileEngineIterator::entryInfo(EntryInfoType type) const
/*!
\fn virtual bool QAbstractFileEngineIterator::hasNext() const = 0
- This pure virtual function returns true if there is at least one more
+ This pure virtual function returns \c true if there is at least one more
entry in the current directory (i.e., the iterator path is valid and
accessible, and the iterator has not reached the end of the entry list).
@@ -1147,14 +1147,14 @@ qint64 QAbstractFileEngine::readLine(char *data, qint64 maxlen)
buffering to report end-of-file status without having to check the size of
the file. It is also useful for sequential files, where the size of the
file cannot be used to determine whether or not you have reached the end.
- This extension returns true if the file is at the end; otherwise it returns
+ This extension returns \c true if the file is at the end; otherwise it returns
false. The input and output arguments to extension() are ignored.
\value FastReadLineExtension Whether the file engine provides a
fast implementation for readLine() or not. If readLine() remains
unimplemented in the file engine, QAbstractFileEngine will provide
an implementation based on calling read() repeatedly. If
- supportsExtension() returns false for this extension, however,
+ supportsExtension() returns \c false for this extension, however,
QIODevice can provide a faster implementation by making use of its
internal buffer. For engines that already provide a fast readLine()
implementation, returning false for this extension can avoid
@@ -1201,7 +1201,7 @@ qint64 QAbstractFileEngine::readLine(char *data, qint64 maxlen)
You can call supportsExtension() to check if an extension is supported by
the file engine.
- By default, no extensions are supported, and this function returns false.
+ By default, no extensions are supported, and this function returns \c false.
\sa supportsExtension(), Extension
*/
@@ -1216,7 +1216,7 @@ bool QAbstractFileEngine::extension(Extension extension, const ExtensionOption *
/*!
\since 4.3
- This virtual function returns true if the file engine supports \a
+ This virtual function returns \c true if the file engine supports \a
extension; otherwise, false is returned. By default, no extensions are
supported.
diff --git a/src/corelib/io/qdatastream.cpp b/src/corelib/io/qdatastream.cpp
index 008460df5d..af5605f8c7 100644
--- a/src/corelib/io/qdatastream.cpp
+++ b/src/corelib/io/qdatastream.cpp
@@ -402,9 +402,9 @@ void QDataStream::unsetDevice()
/*!
\fn bool QDataStream::atEnd() const
- Returns true if the I/O device has reached the end position (end of
+ Returns \c true if the I/O device has reached the end position (end of
the stream or file) or if there is no I/O device set; otherwise
- returns false.
+ returns \c false.
\sa QIODevice::atEnd()
*/
diff --git a/src/corelib/io/qdebug.cpp b/src/corelib/io/qdebug.cpp
index b8cd0f70b2..05920f4575 100644
--- a/src/corelib/io/qdebug.cpp
+++ b/src/corelib/io/qdebug.cpp
@@ -169,7 +169,7 @@ QT_BEGIN_NAMESPACE
/*!
\fn bool QDebug::autoInsertSpaces() const
- Returns true if this QDebug instance will automatically insert spaces
+ Returns \c true if this QDebug instance will automatically insert spaces
between writes.
\since 5.0
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()
diff --git a/src/corelib/io/qdiriterator.cpp b/src/corelib/io/qdiriterator.cpp
index fe9a423c58..5b48c4c7db 100644
--- a/src/corelib/io/qdiriterator.cpp
+++ b/src/corelib/io/qdiriterator.cpp
@@ -308,7 +308,7 @@ void QDirIteratorPrivate::checkAndPushDirectory(const QFileInfo &fileInfo)
This convenience function implements the iterator's filtering logics and
applies then to the current directory entry.
- It returns true if the current entry matches the filters (i.e., the
+ It returns \c true if the current entry matches the filters (i.e., the
current entry will be returned as part of the directory iteration);
otherwise, false is returned.
*/
@@ -476,7 +476,7 @@ QDirIterator::~QDirIterator()
/*!
Advances the iterator to the next entry, and returns the file path of this
- new entry. If hasNext() returns false, this function does nothing, and
+ new entry. If hasNext() returns \c false, this function does nothing, and
returns a null QString.
You can call fileName() or filePath() to get the current entry file name
@@ -491,7 +491,7 @@ QString QDirIterator::next()
}
/*!
- Returns true if there is at least one more entry in the directory;
+ Returns \c true if there is at least one more entry in the directory;
otherwise, false is returned.
\sa next(), fileName(), filePath(), fileInfo()
diff --git a/src/corelib/io/qfile.cpp b/src/corelib/io/qfile.cpp
index d991e86839..519ac009aa 100644
--- a/src/corelib/io/qfile.cpp
+++ b/src/corelib/io/qfile.cpp
@@ -143,7 +143,7 @@ QAbstractFileEngine *QFilePrivate::engine() const
The size of the file is returned by size(). You can get the
current file position using pos(), or move to a new file position
using seek(). If you've reached the end of the file, atEnd()
- returns true.
+ returns \c true.
\section1 Reading Files Directly
@@ -403,8 +403,8 @@ QFile::setFileName(const QString &name)
/*!
\overload
- Returns true if the file specified by fileName() exists; otherwise
- returns false.
+ Returns \c true if the file specified by fileName() exists; otherwise
+ returns \c false.
\sa fileName(), setFileName()
*/
@@ -419,8 +419,8 @@ QFile::exists() const
}
/*!
- Returns true if the file specified by \a fileName exists; otherwise
- returns false.
+ Returns \c true if the file specified by \a fileName exists; otherwise
+ returns \c false.
\note If \a fileName is a symlink that points to a non-existing
file, false is returned.
@@ -442,7 +442,7 @@ QFile::exists(const QString &fileName)
link.
This name may not represent an existing file; it is only a string.
- QFile::exists() returns true if the symlink points to an existing file.
+ QFile::exists() returns \c true if the symlink points to an existing file.
\sa fileName(), setFileName()
*/
@@ -468,7 +468,7 @@ QFile::readLink() const
empty string if the \a fileName does not correspond to a symbolic link.
This name may not represent an existing file; it is only a string.
- QFile::exists() returns true if the symlink points to an existing file.
+ QFile::exists() returns \c true if the symlink points to an existing file.
*/
/*!
@@ -483,8 +483,8 @@ QFile::readLink(const QString &fileName)
}
/*!
- Removes the file specified by fileName(). Returns true if successful;
- otherwise returns false.
+ Removes the file specified by fileName(). Returns \c true if successful;
+ otherwise returns \c false.
The file is closed before it is removed.
@@ -516,7 +516,7 @@ QFile::remove()
Removes the file specified by the \a fileName given.
- Returns true if successful; otherwise returns false.
+ Returns \c true if successful; otherwise returns \c false.
\sa remove()
*/
@@ -529,9 +529,9 @@ QFile::remove(const QString &fileName)
/*!
Renames the file currently specified by fileName() to \a newName.
- Returns true if successful; otherwise returns false.
+ Returns \c true if successful; otherwise returns \c false.
- If a file with the name \a newName already exists, rename() returns false
+ If a file with the name \a newName already exists, rename() returns \c false
(i.e., QFile will not overwrite it).
The file is closed before it is renamed.
@@ -660,10 +660,10 @@ QFile::rename(const QString &newName)
/*!
\overload
- Renames the file \a oldName to \a newName. Returns true if
- successful; otherwise returns false.
+ Renames the file \a oldName to \a newName. Returns \c true if
+ successful; otherwise returns \c false.
- If a file with the name \a newName already exists, rename() returns false
+ If a file with the name \a newName already exists, rename() returns \c false
(i.e., QFile will not overwrite it).
\sa rename()
@@ -679,8 +679,8 @@ QFile::rename(const QString &oldName, const QString &newName)
Creates a link named \a linkName that points to the file currently specified by
fileName(). What a link is depends on the underlying filesystem (be it a
- shortcut on Windows or a symbolic link on Unix). Returns true if successful;
- otherwise returns false.
+ shortcut on Windows or a symbolic link on Unix). Returns \c true if successful;
+ otherwise returns \c false.
This function will not overwrite an already existing entity in the file system;
in this case, \c link() will return false and set \l{QFile::}{error()} to
@@ -713,8 +713,8 @@ QFile::link(const QString &linkName)
Creates a link named \a linkName that points to the file \a fileName. What a link is
depends on the underlying filesystem (be it a shortcut on Windows
- or a symbolic link on Unix). Returns true if successful; otherwise
- returns false.
+ or a symbolic link on Unix). Returns \c true if successful; otherwise
+ returns \c false.
\sa link()
*/
@@ -727,10 +727,10 @@ QFile::link(const QString &fileName, const QString &linkName)
/*!
Copies the file currently specified by fileName() to a file called
- \a newName. Returns true if successful; otherwise returns false.
+ \a newName. Returns \c true if successful; otherwise returns \c false.
Note that if a file with the name \a newName already exists,
- copy() returns false (i.e. QFile will not overwrite it).
+ copy() returns \c false (i.e. QFile will not overwrite it).
The source file is closed before it is copied.
@@ -830,10 +830,10 @@ QFile::copy(const QString &newName)
/*!
\overload
- Copies the file \a fileName to \a newName. Returns true if successful;
- otherwise returns false.
+ Copies the file \a fileName to \a newName. Returns \c true if successful;
+ otherwise returns \c false.
- If a file with the name \a newName already exists, copy() returns false
+ If a file with the name \a newName already exists, copy() returns \c false
(i.e., QFile will not overwrite it).
\sa rename()
@@ -894,7 +894,7 @@ bool QFile::open(OpenMode mode)
Opens the existing file handle \a fh in the given \a mode.
\a handleFlags may be used to specify additional options.
- Returns true if successful; otherwise returns false.
+ Returns \c true if successful; otherwise returns \c false.
Example:
\snippet code/src_corelib_io_qfile.cpp 3
@@ -966,7 +966,7 @@ bool QFile::open(FILE *fh, OpenMode mode, FileHandleFlags handleFlags)
Opens the existing file descriptor \a fd in the given \a mode.
\a handleFlags may be used to specify additional options.
- Returns true if successful; otherwise returns false.
+ Returns \c true if successful; otherwise returns \c false.
When a QFile is opened using this function, behaviour of close() is
controlled by the AutoCloseHandle flag.
@@ -1031,7 +1031,7 @@ bool QFile::resize(qint64 sz)
/*!
\overload
- Sets \a fileName to size (in bytes) \a sz. Returns true if the file if
+ Sets \a fileName to size (in bytes) \a sz. Returns \c true if the file if
the resize succeeds; false otherwise. If \a sz is larger than \a
fileName currently is the new bytes will be set to 0, if \a sz is
smaller the file is simply truncated.
@@ -1068,7 +1068,7 @@ QFile::permissions(const QString &fileName)
/*!
Sets the permissions for the file to the \a permissions specified.
- Returns true if successful, or false if the permissions cannot be
+ Returns \c true if successful, or false if the permissions cannot be
modified.
\sa permissions(), setFileName()
diff --git a/src/corelib/io/qfiledevice.cpp b/src/corelib/io/qfiledevice.cpp
index 8825ec33b3..f25933816a 100644
--- a/src/corelib/io/qfiledevice.cpp
+++ b/src/corelib/io/qfiledevice.cpp
@@ -232,8 +232,8 @@ QFileDevice::~QFileDevice()
}
/*!
- Returns true if the file can only be manipulated sequentially;
- otherwise returns false.
+ Returns \c true if the file can only be manipulated sequentially;
+ otherwise returns \c false.
Most files support random-access, but some special files may not.
@@ -286,8 +286,8 @@ static inline qint64 _qfile_writeData(QAbstractFileEngine *engine, QRingBuffer *
}
/*!
- Flushes any buffered data to the file. Returns true if successful;
- otherwise returns false.
+ Flushes any buffered data to the file. Returns \c true if successful;
+ otherwise returns \c false.
*/
bool QFileDevice::flush()
{
@@ -351,11 +351,11 @@ qint64 QFileDevice::pos() const
}
/*!
- Returns true if the end of the file has been reached; otherwise returns
+ Returns \c true if the end of the file has been reached; otherwise returns
false.
For regular empty files on Unix (e.g. those in \c /proc), this function
- returns true, since the file system reports that the size of such a file is
+ returns \c true, since the file system reports that the size of such a file is
0. Therefore, you should not depend on atEnd() when reading data from such a
file, but rather call read() until no more data can be read.
*/
@@ -578,7 +578,7 @@ qint64 QFileDevice::writeData(const char *data, qint64 len)
Returns the file error status.
The I/O device status returns an error code. For example, if open()
- returns false, or a read/write operation returns -1, this function can
+ returns \c false, or a read/write operation returns -1, this function can
be called to find out the reason why the operation failed.
\sa unsetError()
@@ -617,7 +617,7 @@ qint64 QFileDevice::size() const
}
/*!
- Sets the file size (in bytes) \a sz. Returns true if the file if the
+ Sets the file size (in bytes) \a sz. Returns \c true if the file if the
resize succeeds; false otherwise. If \a sz is larger than the file
currently is the new bytes will be set to 0, if \a sz is smaller the
file is simply truncated.
@@ -657,7 +657,7 @@ QFile::Permissions QFileDevice::permissions() const
/*!
Sets the permissions for the file to the \a permissions specified.
- Returns true if successful, or false if the permissions cannot be
+ Returns \c true if successful, or false if the permissions cannot be
modified.
\sa permissions()
@@ -715,7 +715,7 @@ uchar *QFileDevice::map(qint64 offset, qint64 size, MemoryMapFlags flags)
/*!
Unmaps the memory \a address.
- Returns true if the unmap succeeds; false otherwise.
+ Returns \c true if the unmap succeeds; false otherwise.
\sa map()
*/
diff --git a/src/corelib/io/qfileinfo.cpp b/src/corelib/io/qfileinfo.cpp
index d1b7ebac65..90122a9f0d 100644
--- a/src/corelib/io/qfileinfo.cpp
+++ b/src/corelib/io/qfileinfo.cpp
@@ -379,15 +379,15 @@ QFileInfo::~QFileInfo()
/*!
\fn bool QFileInfo::operator!=(const QFileInfo &fileinfo) const
- Returns true if this QFileInfo object refers to a different file
- than the one specified by \a fileinfo; otherwise returns false.
+ Returns \c true if this QFileInfo object refers to a different file
+ than the one specified by \a fileinfo; otherwise returns \c false.
\sa operator==()
*/
/*!
- Returns true if this QFileInfo object refers to a file in the same
- location as \a fileinfo; otherwise returns false.
+ Returns \c true if this QFileInfo object refers to a file in the same
+ location as \a fileinfo; otherwise returns \c false.
Note that the result of comparing two empty QFileInfo objects,
containing no file references (file paths that do not exist or
@@ -615,14 +615,14 @@ QString QFileInfo::path() const
/*!
\fn bool QFileInfo::isAbsolute() const
- Returns true if the file path name is absolute, otherwise returns
+ Returns \c true if the file path name is absolute, otherwise returns
false if the path is relative.
\sa isRelative()
*/
/*!
- Returns true if the file path name is relative, otherwise returns
+ Returns \c true if the file path name is relative, otherwise returns
false if the path is absolute (e.g. under Unix a path is absolute
if it begins with a "/").
@@ -640,7 +640,7 @@ bool QFileInfo::isRelative() const
/*!
Converts the file's path to an absolute path if it is not already in that form.
- Returns true to indicate that the path was converted; otherwise returns false
+ Returns \c true to indicate that the path was converted; otherwise returns \c false
to indicate that the path was already absolute.
\sa filePath(), isRelative()
@@ -656,7 +656,7 @@ bool QFileInfo::makeAbsolute()
}
/*!
- Returns true if the file exists; otherwise returns false.
+ Returns \c true if the file exists; otherwise returns \c false.
\note If the file is a symlink that points to a non-existing
file, false is returned.
@@ -675,7 +675,7 @@ bool QFileInfo::exists() const
}
/*!
- Returns true if the \a file exists; otherwise returns false.
+ Returns \c true if the \a file exists; otherwise returns \c false.
\note If \a file is a symlink that points to a non-existing
file, false is returned.
@@ -884,7 +884,7 @@ QDir QFileInfo::absoluteDir() const
}
/*!
- Returns true if the user can read the file; otherwise returns false.
+ Returns \c true if the user can read the file; otherwise returns \c false.
\sa isWritable(), isExecutable(), permission()
*/
@@ -902,7 +902,7 @@ bool QFileInfo::isReadable() const
}
/*!
- Returns true if the user can write to the file; otherwise returns false.
+ Returns \c true if the user can write to the file; otherwise returns \c false.
\sa isReadable(), isExecutable(), permission()
*/
@@ -920,7 +920,7 @@ bool QFileInfo::isWritable() const
}
/*!
- Returns true if the file is executable; otherwise returns false.
+ Returns \c true if the file is executable; otherwise returns \c false.
\sa isReadable(), isWritable(), permission()
*/
@@ -938,9 +938,9 @@ bool QFileInfo::isExecutable() const
}
/*!
- Returns true if this is a `hidden' file; otherwise returns false.
+ Returns \c true if this is a `hidden' file; otherwise returns \c false.
- \b{Note:} This function returns true for the special entries
+ \b{Note:} This function returns \c true for the special entries
"." and ".." on Unix, even though QDir::entryList threats them as shown.
*/
bool QFileInfo::isHidden() const
@@ -958,8 +958,8 @@ bool QFileInfo::isHidden() const
/*!
\since 5.0
- Returns true if the file path can be used directly with native APIs.
- Returns false if the file is otherwise supported by a virtual file system
+ Returns \c true if the file path can be used directly with native APIs.
+ Returns \c false if the file is otherwise supported by a virtual file system
inside Qt, such as \l{the Qt Resource System}.
\b{Note:} Native paths may still require conversion of path separators
@@ -980,8 +980,8 @@ bool QFileInfo::isNativePath() const
}
/*!
- Returns true if this object points to a file or to a symbolic
- link to a file. Returns false if the
+ Returns \c true if this object points to a file or to a symbolic
+ link to a file. Returns \c false if the
object points to something which isn't a file, such as a directory.
\sa isDir(), isSymLink(), isBundle()
@@ -1000,8 +1000,8 @@ bool QFileInfo::isFile() const
}
/*!
- Returns true if this object points to a directory or to a symbolic
- link to a directory; otherwise returns false.
+ Returns \c true if this object points to a directory or to a symbolic
+ link to a directory; otherwise returns \c false.
\sa isFile(), isSymLink(), isBundle()
*/
@@ -1021,8 +1021,8 @@ bool QFileInfo::isDir() const
/*!
\since 4.3
- Returns true if this object points to a bundle or to a symbolic
- link to a bundle on Mac OS X; otherwise returns false.
+ Returns \c true if this object points to a bundle or to a symbolic
+ link to a bundle on Mac OS X; otherwise returns \c false.
\sa isDir(), isSymLink(), isFile()
*/
@@ -1040,8 +1040,8 @@ bool QFileInfo::isBundle() const
}
/*!
- Returns true if this object points to a symbolic link (or to a
- shortcut on Windows); otherwise returns false.
+ Returns \c true if this object points to a symbolic link (or to a
+ shortcut on Windows); otherwise returns \c false.
On Unix (including Mac OS X), opening a symlink effectively opens
the \l{symLinkTarget()}{link's target}. On Windows, it opens the \c
@@ -1070,9 +1070,9 @@ bool QFileInfo::isSymLink() const
}
/*!
- Returns true if the object points to a directory or to a symbolic
+ Returns \c true if the object points to a directory or to a symbolic
link to a directory, and that directory is the root directory; otherwise
- returns false.
+ returns \c false.
*/
bool QFileInfo::isRoot() const
{
@@ -1105,7 +1105,7 @@ bool QFileInfo::isRoot() const
link.
This name may not represent an existing file; it is only a string.
- QFileInfo::exists() returns true if the symlink points to an
+ QFileInfo::exists() returns \c true if the symlink points to an
existing file.
\sa exists(), isSymLink(), isDir(), isFile()
@@ -1208,7 +1208,7 @@ uint QFileInfo::groupId() const
for permission combinations.
On systems where files do not have permissions this function
- always returns true.
+ always returns \c true.
Example:
\snippet code/src_corelib_io_qfileinfo.cpp 10
@@ -1348,7 +1348,7 @@ QFileInfoPrivate* QFileInfo::d_func()
}
/*!
- Returns true if caching is enabled; otherwise returns false.
+ Returns \c true if caching is enabled; otherwise returns \c false.
\sa setCaching(), refresh()
*/
diff --git a/src/corelib/io/qfsfileengine.cpp b/src/corelib/io/qfsfileengine.cpp
index f0f3c935e6..998a3334c9 100644
--- a/src/corelib/io/qfsfileengine.cpp
+++ b/src/corelib/io/qfsfileengine.cpp
@@ -224,8 +224,8 @@ bool QFSFileEngine::open(QIODevice::OpenMode openMode)
}
/*!
- Opens the file handle \a fh in \a openMode mode. Returns true on
- success; otherwise returns false.
+ Opens the file handle \a fh in \a openMode mode. Returns \c true on
+ success; otherwise returns \c false.
*/
bool QFSFileEngine::open(QIODevice::OpenMode openMode, FILE *fh)
{
@@ -285,8 +285,8 @@ bool QFSFileEnginePrivate::openFh(QIODevice::OpenMode openMode, FILE *fh)
}
/*!
- Opens the file descriptor \a fd in \a openMode mode. Returns true
- on success; otherwise returns false.
+ Opens the file descriptor \a fd in \a openMode mode. Returns \c true
+ on success; otherwise returns \c false.
*/
bool QFSFileEngine::open(QIODevice::OpenMode openMode, int fd)
{
@@ -837,7 +837,7 @@ bool QFSFileEngine::supportsExtension(Extension extension) const
}
/*! \fn bool QFSFileEngine::caseSensitive() const
- Returns true for Windows, false for Unix.
+ Returns \c true for Windows, false for Unix.
*/
/*! \fn bool QFSFileEngine::copy(const QString &copyName)
@@ -892,7 +892,7 @@ bool QFSFileEngine::supportsExtension(Extension extension) const
Creates a link from the file currently specified by fileName() to
\a newName. What a link is depends on the underlying filesystem
(be it a shortcut on Windows or a symbolic link on Unix). Returns
- true if successful; otherwise returns false.
+ true if successful; otherwise returns \c false.
*/
/*! \fn bool QFSFileEngine::mkdir(const QString &name, bool createParentDirectories) const
@@ -935,8 +935,8 @@ bool QFSFileEngine::supportsExtension(Extension extension) const
*/
/*! \fn bool QFSFileEngine::setCurrentPath(const QString &path)
- Sets the current path (e.g., for QDir), to \a path. Returns true if the
- new path exists; otherwise this function does nothing, and returns false.
+ Sets the current path (e.g., for QDir), to \a path. Returns \c true if the
+ new path exists; otherwise this function does nothing, and returns \c false.
\sa currentPath()
*/
diff --git a/src/corelib/io/qiodevice.cpp b/src/corelib/io/qiodevice.cpp
index 1b06f3ec86..8fb80123fa 100644
--- a/src/corelib/io/qiodevice.cpp
+++ b/src/corelib/io/qiodevice.cpp
@@ -400,7 +400,7 @@ QIODevice::~QIODevice()
}
/*!
- Returns true if this device is sequential; otherwise returns
+ Returns \c true if this device is sequential; otherwise returns
false.
Sequential devices, as opposed to a random-access devices, have no
@@ -476,7 +476,7 @@ void QIODevice::setTextModeEnabled(bool enabled)
}
/*!
- Returns true if the \l Text flag is enabled; otherwise returns false.
+ Returns \c true if the \l Text flag is enabled; otherwise returns \c false.
\sa setTextModeEnabled()
*/
@@ -486,9 +486,9 @@ bool QIODevice::isTextModeEnabled() const
}
/*!
- Returns true if the device is open; otherwise returns false. A
+ Returns \c true if the device is open; otherwise returns \c false. A
device is open if it can be read from and/or written to. By
- default, this function returns false if openMode() returns
+ default, this function returns \c false if openMode() returns
\c NotOpen.
\sa openMode(), OpenMode
@@ -499,7 +499,7 @@ bool QIODevice::isOpen() const
}
/*!
- Returns true if data can be read from the device; otherwise returns
+ Returns \c true if data can be read from the device; otherwise returns
false. Use bytesAvailable() to determine how many bytes can be read.
This is a convenience function which checks if the OpenMode of the
@@ -513,7 +513,7 @@ bool QIODevice::isReadable() const
}
/*!
- Returns true if data can be written to the device; otherwise returns
+ Returns \c true if data can be written to the device; otherwise returns
false.
This is a convenience function which checks if the OpenMode of the
@@ -527,8 +527,8 @@ bool QIODevice::isWritable() const
}
/*!
- Opens the device and sets its OpenMode to \a mode. Returns true if successful;
- otherwise returns false. This function should be called from any
+ Opens the device and sets its OpenMode to \a mode. Returns \c true if successful;
+ otherwise returns \c false. This function should be called from any
reimplementations of open() or other functions that open the device.
\sa openMode(), OpenMode
@@ -665,9 +665,9 @@ bool QIODevice::seek(qint64 pos)
}
/*!
- Returns true if the current read and write position is at the end
+ Returns \c true if the current read and write position is at the end
of the device (i.e. there is no more data available for reading on
- the device); otherwise returns false.
+ the device); otherwise returns \c false.
For some devices, atEnd() can return true even though there is more data
to read. This special case only applies to devices that generate data in
@@ -688,7 +688,7 @@ bool QIODevice::atEnd() const
/*!
Seeks to the start of input for random-access devices. Returns
- true on success; otherwise returns false (for example, if the
+ true on success; otherwise returns \c false (for example, if the
device is not open).
Note that when using a QTextStream on a QFile, calling reset() on
@@ -1268,8 +1268,8 @@ qint64 QIODevice::readLineData(char *data, qint64 maxSize)
#endif
/*!
- Returns true if a complete line of data can be read from the device;
- otherwise returns false.
+ Returns \c true if a complete line of data can be read from the device;
+ otherwise returns \c false.
Note that unbuffered devices, which have no way of determining what
can be read, always return false.
@@ -1426,8 +1426,8 @@ void QIODevice::ungetChar(char c)
/*! \fn bool QIODevice::putChar(char c)
- Writes the character \a c to the device. Returns true on success;
- otherwise returns false.
+ Writes the character \a c to the device. Returns \c true on success;
+ otherwise returns \c false.
\sa write(), getChar(), ungetChar()
*/
@@ -1476,8 +1476,8 @@ QByteArray QIODevicePrivate::peek(qint64 maxSize)
/*! \fn bool QIODevice::getChar(char *c)
Reads one character from the device and stores it in \a c. If \a c
- is 0, the character is discarded. Returns true on success;
- otherwise returns false.
+ is 0, the character is discarded. Returns \c true on success;
+ otherwise returns \c false.
\sa read(), putChar(), ungetChar()
*/
@@ -1537,7 +1537,7 @@ QByteArray QIODevice::peek(qint64 maxSize)
signal has been emitted, or until \a msecs milliseconds have
passed. If msecs is -1, this function will not time out.
- Returns true if new data is available for reading; otherwise returns
+ Returns \c true if new data is available for reading; otherwise returns
false (if the operation timed out or if an error occurred).
This function can operate without an event loop. It is
@@ -1548,7 +1548,7 @@ QByteArray QIODevice::peek(qint64 maxSize)
readyRead() will not be reemitted.
Reimplement this function to provide a blocking API for a custom
- device. The default implementation does nothing, and returns false.
+ device. The default implementation does nothing, and returns \c false.
\warning Calling this function from the main (GUI) thread
might cause your user interface to freeze.
@@ -1568,8 +1568,8 @@ bool QIODevice::waitForReadyRead(int msecs)
milliseconds have passed. If msecs is -1, this function will
not time out. For unbuffered devices, it returns immediately.
- Returns true if a payload of data was written to the device;
- otherwise returns false (i.e. if the operation timed out, or if an
+ Returns \c true if a payload of data was written to the device;
+ otherwise returns \c false (i.e. if the operation timed out, or if an
error occurred).
This function can operate without an event loop. It is
@@ -1580,7 +1580,7 @@ bool QIODevice::waitForReadyRead(int msecs)
bytesWritten() will not be reemitted.
Reimplement this function to provide a blocking API for a custom
- device. The default implementation does nothing, and returns false.
+ device. The default implementation does nothing, and returns \c false.
\warning Calling this function from the main (GUI) thread
might cause your user interface to freeze.
diff --git a/src/corelib/io/qlockfile.cpp b/src/corelib/io/qlockfile.cpp
index 5d56a67f48..e24a7e85a8 100644
--- a/src/corelib/io/qlockfile.cpp
+++ b/src/corelib/io/qlockfile.cpp
@@ -154,8 +154,8 @@ int QLockFile::staleLockTime() const
}
/*!
- Returns true if the lock was acquired by this QLockFile instance,
- otherwise returns false.
+ Returns \c true if the lock was acquired by this QLockFile instance,
+ otherwise returns \c false.
\sa lock(), unlock(), tryLock()
*/
@@ -175,7 +175,7 @@ bool QLockFile::isLocked() const
thread without unlocking first is not allowed. This function will
\e dead-lock when the file is locked recursively.
- Returns true if the lock was acquired, false if it could not be acquired
+ Returns \c true if the lock was acquired, false if it could not be acquired
due to an unrecoverable error, such as no permissions in the parent directory.
\sa unlock(), tryLock()
@@ -186,8 +186,8 @@ bool QLockFile::lock()
}
/*!
- Attempts to create the lock file. This function returns true if the
- lock was obtained; otherwise it returns false. If another process (or
+ Attempts to create the lock file. This function returns \c true if the
+ lock was obtained; otherwise it returns \c false. If another process (or
another thread) has created the lock file already, this function will
wait for at most \a timeout milliseconds for the lock file to become
available.
@@ -255,7 +255,7 @@ bool QLockFile::tryLock(int timeout)
/*!
Retrieves information about the current owner of the lock file.
- If tryLock() returns false, and error() returns LockFailedError,
+ If tryLock() returns \c false, and error() returns LockFailedError,
this function can be called to find out more information about the existing
lock file:
\list
@@ -272,7 +272,7 @@ bool QLockFile::tryLock(int timeout)
the choice to delete it. After removing the file using removeStaleLockFile(),
the application can call tryLock() again.
- This function returns true if the information could be successfully retrieved, false
+ This function returns \c true if the information could be successfully retrieved, false
if the lock file doesn't exist or doesn't contain the expected data.
This can happen if the lock file was deleted between the time where tryLock() failed
and the call to this function. Simply call tryLock() again if this happens.
@@ -318,7 +318,7 @@ bool QLockFilePrivate::getLockInfo(qint64 *pid, QString *hostname, QString *appn
with staleLockTime(0), and after tryLock() returned LockFailedError, and the user
agreed on removing the lock file.
- Returns true on success, false if the lock file couldn't be removed. This happens
+ Returns \c true on success, false if the lock file couldn't be removed. This happens
on Windows, when the application owning the lock is still running.
*/
bool QLockFile::removeStaleLockFile()
@@ -334,7 +334,7 @@ bool QLockFile::removeStaleLockFile()
/*!
Returns the lock file error status.
- If tryLock() returns false, this function can be called to find out
+ If tryLock() returns \c false, this function can be called to find out
the reason why the locking failed.
*/
QLockFile::LockError QLockFile::error() const
diff --git a/src/corelib/io/qlockfile_p.h b/src/corelib/io/qlockfile_p.h
index e046e87cf4..e08f86cab9 100644
--- a/src/corelib/io/qlockfile_p.h
+++ b/src/corelib/io/qlockfile_p.h
@@ -80,7 +80,7 @@ public:
QLockFile::LockError tryLock_sys();
bool removeStaleLock();
bool getLockInfo(qint64 *pid, QString *hostname, QString *appname) const;
- // Returns true if the lock belongs to dead PID, or is old.
+ // Returns \c true if the lock belongs to dead PID, or is old.
// The attempt to delete it will tell us if it was really stale or not, though.
bool isApparentlyStale() const;
diff --git a/src/corelib/io/qnoncontiguousbytedevice.cpp b/src/corelib/io/qnoncontiguousbytedevice.cpp
index 253aa2aafb..b1e4dd7584 100644
--- a/src/corelib/io/qnoncontiguousbytedevice.cpp
+++ b/src/corelib/io/qnoncontiguousbytedevice.cpp
@@ -89,7 +89,7 @@ QT_BEGIN_NAMESPACE
/*!
\fn virtual bool QNonContiguousByteDevice::atEnd()
- Returns true if everything has been read and the read
+ Returns \c true if everything has been read and the read
pointer cannot be advanced anymore.
\sa readPointer(), advanceReadPointer(), reset()
@@ -100,7 +100,7 @@ QT_BEGIN_NAMESPACE
\fn virtual bool QNonContiguousByteDevice::reset()
Moves the internal read pointer back to the beginning.
- Returns false if this was not possible.
+ Returns \c false if this was not possible.
\sa atEnd(), disableReset()
diff --git a/src/corelib/io/qprocess.cpp b/src/corelib/io/qprocess.cpp
index fb86b053e9..ab2a69d054 100644
--- a/src/corelib/io/qprocess.cpp
+++ b/src/corelib/io/qprocess.cpp
@@ -249,13 +249,13 @@ QProcessEnvironment &QProcessEnvironment::operator=(const QProcessEnvironment &o
/*!
\fn bool QProcessEnvironment::operator !=(const QProcessEnvironment &other) const
- Returns true if this and the \a other QProcessEnvironment objects are different.
+ Returns \c true if this and the \a other QProcessEnvironment objects are different.
\sa operator==()
*/
/*!
- Returns true if this and the \a other QProcessEnvironment objects are equal.
+ Returns \c true if this and the \a other QProcessEnvironment objects are equal.
Two QProcessEnvironment objects are considered equal if they have the same
set of key=value pairs. The comparison of keys is done case-sensitive on
@@ -275,7 +275,7 @@ bool QProcessEnvironment::operator==(const QProcessEnvironment &other) const
}
/*!
- Returns true if this QProcessEnvironment object is empty: that is
+ Returns \c true if this QProcessEnvironment object is empty: that is
there are no key=value pairs set.
\sa clear(), systemEnvironment(), insert()
@@ -301,7 +301,7 @@ void QProcessEnvironment::clear()
}
/*!
- Returns true if the environment variable of name \a name is found in
+ Returns \c true if the environment variable of name \a name is found in
this QProcessEnvironment object.
@@ -1587,8 +1587,8 @@ void QProcess::close()
/*! \reimp
- Returns true if the process is not running, and no more data is available
- for reading; otherwise returns false.
+ Returns \c true if the process is not running, and no more data is available
+ for reading; otherwise returns \c false.
*/
bool QProcess::atEnd() const
{
@@ -1735,8 +1735,8 @@ QProcessEnvironment QProcess::processEnvironment() const
Blocks until the process has started and the started() signal has
been emitted, or until \a msecs milliseconds have passed.
- Returns true if the process was started successfully; otherwise
- returns false (if the operation timed out or if an error
+ Returns \c true if the process was started successfully; otherwise
+ returns \c false (if the operation timed out or if an error
occurred).
This function can operate without an event loop. It is
@@ -1798,7 +1798,7 @@ bool QProcess::waitForBytesWritten(int msecs)
Blocks until the process has finished and the finished() signal
has been emitted, or until \a msecs milliseconds have passed.
- Returns true if the process finished; otherwise returns false (if
+ Returns \c true if the process finished; otherwise returns \c false (if
the operation timed out, if an error occurred, or if this QProcess
is already finished).
@@ -2366,8 +2366,8 @@ int QProcess::execute(const QString &program)
/*!
Starts the program \a program with the arguments \a arguments in a
- new process, and detaches from it. Returns true on success;
- otherwise returns false. If the calling process exits, the
+ new process, and detaches from it. Returns \c true on success;
+ otherwise returns \c false. If the calling process exits, the
detached process will continue to live.
Note that arguments that contain spaces are not passed to the
@@ -2400,8 +2400,8 @@ bool QProcess::startDetached(const QString &program,
/*!
Starts the program \a program with the given \a arguments in a
- new process, and detaches from it. Returns true on success;
- otherwise returns false. If the calling process exits, the
+ new process, and detaches from it. Returns \c true on success;
+ otherwise returns \c false. If the calling process exits, the
detached process will continue to live.
\note Arguments that contain spaces are not passed to the
diff --git a/src/corelib/io/qresource.cpp b/src/corelib/io/qresource.cpp
index 04ec81e159..c16b8d79a2 100644
--- a/src/corelib/io/qresource.cpp
+++ b/src/corelib/io/qresource.cpp
@@ -451,7 +451,7 @@ QString QResource::absoluteFilePath() const
}
/*!
- Returns true if the resource really exists in the resource hierarchy,
+ Returns \c true if the resource really exists in the resource hierarchy,
false otherwise.
*/
@@ -466,7 +466,7 @@ bool QResource::isValid() const
/*!
\fn bool QResource::isFile() const
- Returns true if the resource represents a file and thus has data
+ Returns \c true if the resource represents a file and thus has data
backing it, false if it represents a directory.
\sa isDir()
@@ -474,7 +474,7 @@ bool QResource::isValid() const
/*!
- Returns true if the resource represents a file and the data backing it
+ Returns \c true if the resource represents a file and the data backing it
is in a compressed format, false otherwise.
\sa data(), isFile()
@@ -517,7 +517,7 @@ const uchar *QResource::data() const
}
/*!
- Returns true if the resource represents a directory and thus may have
+ Returns \c true if the resource represents a directory and thus may have
children() in it, false if it represents a file.
\sa isFile()
@@ -1044,8 +1044,8 @@ static QString qt_resource_fixResourceRoot(QString r) {
\fn bool QResource::registerResource(const QString &rccFileName, const QString &mapRoot)
Registers the resource with the given \a rccFileName at the location in the
- resource tree specified by \a mapRoot, and returns true if the file is
- successfully opened; otherwise returns false.
+ resource tree specified by \a mapRoot, and returns \c true if the file is
+ successfully opened; otherwise returns \c false.
\sa unregisterResource()
*/
@@ -1075,9 +1075,9 @@ QResource::registerResource(const QString &rccFilename, const QString &resourceR
\fn bool QResource::unregisterResource(const QString &rccFileName, const QString &mapRoot)
Unregisters the resource with the given \a rccFileName at the location in
- the resource tree specified by \a mapRoot, and returns true if the
+ the resource tree specified by \a mapRoot, and returns \c true if the
resource is successfully unloaded and no references exist for the
- resource; otherwise returns false.
+ resource; otherwise returns \c false.
\sa registerResource()
*/
@@ -1112,8 +1112,8 @@ QResource::unregisterResource(const QString &rccFilename, const QString &resourc
\since 4.3
Registers the resource with the given \a rccData at the location in the
- resource tree specified by \a mapRoot, and returns true if the file is
- successfully opened; otherwise returns false.
+ resource tree specified by \a mapRoot, and returns \c true if the file is
+ successfully opened; otherwise returns \c false.
\warning The data must remain valid throughout the life of any QFile
that may reference the resource data.
@@ -1147,8 +1147,8 @@ QResource::registerResource(const uchar *rccData, const QString &resourceRoot)
\since 4.3
Unregisters the resource with the given \a rccData at the location in the
- resource tree specified by \a mapRoot, and returns true if the resource is
- successfully unloaded and no references exist into the resource; otherwise returns false.
+ resource tree specified by \a mapRoot, and returns \c true if the resource is
+ successfully unloaded and no references exist into the resource; otherwise returns \c false.
\sa registerResource()
*/
diff --git a/src/corelib/io/qsavefile.cpp b/src/corelib/io/qsavefile.cpp
index 5ed429c464..2b901c7ccd 100644
--- a/src/corelib/io/qsavefile.cpp
+++ b/src/corelib/io/qsavefile.cpp
@@ -253,8 +253,8 @@ void QSaveFile::close()
It is mandatory to call this at the end of the saving operation, otherwise the file will be
discarded.
- If an error happened during writing, deletes the temporary file and returns false.
- Otherwise, renames it to the final fileName and returns true on success.
+ If an error happened during writing, deletes the temporary file and returns \c false.
+ Otherwise, renames it to the final fileName and returns \c true on success.
Finally, closes the device.
\sa cancelWriting()
@@ -372,7 +372,7 @@ void QSaveFile::setDirectWriteFallback(bool enabled)
}
/*!
- Returns true if the fallback solution for saving files in read-only
+ Returns \c true if the fallback solution for saving files in read-only
directories is enabled.
\sa setDirectWriteFallback()
diff --git a/src/corelib/io/qsettings.cpp b/src/corelib/io/qsettings.cpp
index ebcaf062e3..c78b355ac1 100644
--- a/src/corelib/io/qsettings.cpp
+++ b/src/corelib/io/qsettings.cpp
@@ -1714,7 +1714,7 @@ break_out_of_outer_loop:
}
/*
- Returns false on parse error. However, as many keys are read as
+ Returns \c false on parse error. However, as many keys are read as
possible, so if the user doesn't check the status he will get the
most out of the file anyway.
*/
@@ -3181,8 +3181,8 @@ QStringList QSettings::childGroups() const
}
/*!
- Returns true if settings can be written using this QSettings
- object; returns false otherwise.
+ Returns \c true if settings can be written using this QSettings
+ object; returns \c false otherwise.
One reason why isWritable() might return false is if
QSettings operates on a read-only file.
@@ -3267,7 +3267,7 @@ void QSettings::remove(const QString &key)
}
/*!
- Returns true if there exists a setting called \a key; returns
+ Returns \c true if there exists a setting called \a key; returns
false otherwise.
If a group is set using beginGroup(), \a key is taken to be
@@ -3301,7 +3301,7 @@ void QSettings::setFallbacksEnabled(bool b)
}
/*!
- Returns true if fallbacks are enabled; returns false otherwise.
+ Returns \c true if fallbacks are enabled; returns \c false otherwise.
By default, fallbacks are enabled.
diff --git a/src/corelib/io/qstandardpaths.cpp b/src/corelib/io/qstandardpaths.cpp
index ea917c90d9..186321db6e 100644
--- a/src/corelib/io/qstandardpaths.cpp
+++ b/src/corelib/io/qstandardpaths.cpp
@@ -390,7 +390,7 @@ void QStandardPaths::setTestModeEnabled(bool testMode)
\internal
- Returns true if test mode is enabled in QStandardPaths; otherwise returns false.
+ Returns \c true if test mode is enabled in QStandardPaths; otherwise returns \c false.
*/
bool QStandardPaths::isTestModeEnabled()
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()
{
diff --git a/src/corelib/io/qtemporaryfile.cpp b/src/corelib/io/qtemporaryfile.cpp
index c2f421843c..b3cb4e43f8 100644
--- a/src/corelib/io/qtemporaryfile.cpp
+++ b/src/corelib/io/qtemporaryfile.cpp
@@ -587,7 +587,7 @@ QTemporaryFile::~QTemporaryFile()
*/
/*!
- Returns true if the QTemporaryFile is in auto remove
+ Returns \c true if the QTemporaryFile is in auto remove
mode. Auto-remove mode will automatically delete the filename from
disk upon destruction. This makes it very easy to create your
QTemporaryFile object on the stack, fill it with data, read from
diff --git a/src/corelib/io/qtextstream.cpp b/src/corelib/io/qtextstream.cpp
index 8459cdd158..8188628f57 100644
--- a/src/corelib/io/qtextstream.cpp
+++ b/src/corelib/io/qtextstream.cpp
@@ -1085,8 +1085,8 @@ void QTextStream::flush()
}
/*!
- Seeks to the position \a pos in the device. Returns true on
- success; otherwise returns false.
+ Seeks to the position \a pos in the device. Returns \c true on
+ success; otherwise returns \c false.
*/
bool QTextStream::seek(qint64 pos)
{
@@ -1185,7 +1185,7 @@ qint64 QTextStream::pos() const
character.
Whitespace characters are all characters for which
- QChar::isSpace() returns true.
+ QChar::isSpace() returns \c true.
\sa operator>>()
*/
@@ -1517,8 +1517,8 @@ void QTextStream::setStatus(Status status)
}
/*!
- Returns true if there is no more data to be read from the
- QTextStream; otherwise returns false. This is similar to, but not
+ Returns \c true if there is no more data to be read from the
+ QTextStream; otherwise returns \c false. This is similar to, but not
the same as calling QIODevice::atEnd(), as QTextStream also takes
into account its internal Unicode buffer.
*/
@@ -2091,7 +2091,7 @@ QTextStream &QTextStream::operator>>(double &f)
/*!
Reads a word from the stream and stores it in \a str, then returns
a reference to the stream. Words are separated by whitespace
- (i.e., all characters for which QChar::isSpace() returns true).
+ (i.e., all characters for which QChar::isSpace() returns \c true).
Leading whitespace is skipped.
*/
@@ -2943,8 +2943,8 @@ void QTextStream::setAutoDetectUnicode(bool enabled)
}
/*!
- Returns true if automatic Unicode detection is enabled, otherwise
- returns false. Automatic Unicode detection is enabled by default.
+ Returns \c true if automatic Unicode detection is enabled, otherwise
+ returns \c false. Automatic Unicode detection is enabled by default.
\sa setAutoDetectUnicode(), setCodec()
*/
@@ -2974,8 +2974,8 @@ void QTextStream::setGenerateByteOrderMark(bool generate)
}
/*!
- Returns true if QTextStream is set to generate the UTF BOM (Byte Order
- Mark) when using a UTF codec; otherwise returns false. UTF BOM generation is
+ Returns \c true if QTextStream is set to generate the UTF BOM (Byte Order
+ Mark) when using a UTF codec; otherwise returns \c false. UTF BOM generation is
set to false by default.
\sa setGenerateByteOrderMark()
diff --git a/src/corelib/io/qurl.cpp b/src/corelib/io/qurl.cpp
index d14add36a5..6b7c5bde2d 100644
--- a/src/corelib/io/qurl.cpp
+++ b/src/corelib/io/qurl.cpp
@@ -77,7 +77,7 @@
password at once.
Call isValid() to check if the URL is valid. This can be done at any point
- during the constructing of a URL. If isValid() returns false, you should
+ during the constructing of a URL. If isValid() returns \c false, you should
clear() the URL before proceeding, or start over by parsing a new URL with
setUrl().
@@ -1749,7 +1749,7 @@ QUrl::~QUrl()
}
/*!
- Returns true if the URL is non-empty and valid; otherwise returns false.
+ Returns \c true if the URL is non-empty and valid; otherwise returns \c false.
The URL is run through a conformance test. Every part of the URL
must conform to the standard encoding rules of the URI standard
@@ -1767,7 +1767,7 @@ bool QUrl::isValid() const
}
/*!
- Returns true if the URL has no data; otherwise returns false.
+ Returns \c true if the URL has no data; otherwise returns \c false.
\sa clear()
*/
@@ -2507,7 +2507,7 @@ QString QUrl::fileName(ComponentFormattingOptions options) const
/*!
\since 4.2
- Returns true if this URL contains a Query (i.e., if ? was seen on it).
+ Returns \c true if this URL contains a Query (i.e., if ? was seen on it).
\sa setQuery(), query(), hasFragment()
*/
@@ -2714,7 +2714,7 @@ void QUrl::setQuery(const QUrlQuery &query)
\fn bool QUrl::hasQueryItem(const QString &key) const
\deprecated
- Returns true if there is a query string pair whose key is equal
+ Returns \c true if there is a query string pair whose key is equal
to \a key from the URL.
\obsolete Use QUrlQuery.
@@ -2727,7 +2727,7 @@ void QUrl::setQuery(const QUrlQuery &query)
\deprecated
\since 4.4
- Returns true if there is a query string pair whose key is equal
+ Returns \c true if there is a query string pair whose key is equal
to \a key from the URL.
\obsolete Use QUrlQuery.
@@ -2998,7 +2998,7 @@ QString QUrl::fragment(ComponentFormattingOptions options) const
/*!
\since 4.2
- Returns true if this URL contains a fragment (i.e., if # was seen on it).
+ Returns \c true if this URL contains a fragment (i.e., if # was seen on it).
\sa fragment(), setFragment()
*/
@@ -3114,7 +3114,7 @@ QUrl QUrl::resolved(const QUrl &relative) const
}
/*!
- Returns true if the URL is relative; otherwise returns false. A URL is
+ Returns \c true if the URL is relative; otherwise returns \c false. A URL is
relative reference if its scheme is undefined; this function is therefore
equivalent to calling scheme().isEmpty().
@@ -3441,7 +3441,7 @@ QByteArray QUrl::toAce(const QString &domain)
/*!
\internal
- Returns true if this URL is "less than" the given \a url. This
+ Returns \c true if this URL is "less than" the given \a url. This
provides a means of ordering URLs.
*/
bool QUrl::operator <(const QUrl &url) const
@@ -3493,8 +3493,8 @@ bool QUrl::operator <(const QUrl &url) const
}
/*!
- Returns true if this URL and the given \a url are equal;
- otherwise returns false.
+ Returns \c true if this URL and the given \a url are equal;
+ otherwise returns \c false.
*/
bool QUrl::operator ==(const QUrl &url) const
{
@@ -3522,8 +3522,8 @@ bool QUrl::operator ==(const QUrl &url) const
/*!
\since 5.2
- Returns true if this URL and the given \a url are equal after
- applying \a options to both; otherwise returns false.
+ Returns \c true if this URL and the given \a url are equal after
+ applying \a options to both; otherwise returns \c false.
This is equivalent to calling adjusted(options) on both URLs
and comparing the resulting urls, but faster.
@@ -3589,8 +3589,8 @@ bool QUrl::matches(const QUrl &url, FormattingOptions options) const
}
/*!
- Returns true if this URL and the given \a url are not equal;
- otherwise returns false.
+ Returns \c true if this URL and the given \a url are not equal;
+ otherwise returns \c false.
*/
bool QUrl::operator !=(const QUrl &url) const
{
@@ -3735,7 +3735,7 @@ QString QUrl::toLocalFile() const
/*!
\since 4.8
- Returns true if this URL is pointing to a local file path. A URL is a
+ Returns \c true if this URL is pointing to a local file path. A URL is a
local file path if the scheme is "file".
Note that this function considers URLs with hostnames to be local file
@@ -3754,7 +3754,7 @@ bool QUrl::isLocalFile() const
}
/*!
- Returns true if this URL is a parent of \a childUrl. \a childUrl is a child
+ Returns \c true if this URL is a parent of \a childUrl. \a childUrl is a child
of this URL if the two URLs share the same scheme and authority,
and this URL's path is a parent of the path of \a childUrl.
*/
@@ -3905,7 +3905,7 @@ static inline void appendComponentIfPresent(QString &msg, bool present, const ch
Returns an error message if the last operation that modified this QUrl
object ran into a parsing error. If no error was detected, this function
- returns an empty string and isValid() returns true.
+ returns an empty string and isValid() returns \c true.
The error message returned by this function is technical in nature and may
not be understood by end users. It is mostly useful to developers trying to
diff --git a/src/corelib/io/qurlquery.cpp b/src/corelib/io/qurlquery.cpp
index f773af1433..9ed17671ce 100644
--- a/src/corelib/io/qurlquery.cpp
+++ b/src/corelib/io/qurlquery.cpp
@@ -407,7 +407,7 @@ QUrlQuery::~QUrlQuery()
}
/*!
- Returns true if this object and the \a other object contain the same
+ Returns \c true if this object and the \a other object contain the same
contents, in the same order, and use the same query delimiters.
*/
bool QUrlQuery::operator ==(const QUrlQuery &other) const
@@ -422,7 +422,7 @@ bool QUrlQuery::operator ==(const QUrlQuery &other) const
}
/*!
- Returns true if this QUrlQUery object contains no key-value pairs, such as
+ Returns \c true if this QUrlQUery object contains no key-value pairs, such as
after being default-constructed or after parsing an empty query string.
\sa setQuery(), clear()
@@ -636,7 +636,7 @@ QList<QPair<QString, QString> > QUrlQuery::queryItems(QUrl::ComponentFormattingO
}
/*!
- Returns true if there is a query string pair whose key is equal
+ Returns \c true if there is a query string pair whose key is equal
to \a key from the URL.
\sa addQueryItem(), queryItemValue()
@@ -781,7 +781,7 @@ void QUrlQuery::removeAllQueryItems(const QString &key)
/*!
\fn bool QUrlQuery::operator!=(const QUrlQuery &other) const
- Returns true if \a other is not equal to this QUrlQuery. Otherwise, returns false.
+ Returns \c true if \a other is not equal to this QUrlQuery. Otherwise, returns \c false.
\sa operator==()
*/
diff --git a/src/corelib/io/qwindowspipereader.cpp b/src/corelib/io/qwindowspipereader.cpp
index 2cb5845768..fc9d191a90 100644
--- a/src/corelib/io/qwindowspipereader.cpp
+++ b/src/corelib/io/qwindowspipereader.cpp
@@ -247,7 +247,7 @@ void QWindowsPipeReader::startAsyncRead()
/*!
\internal
Sets the correct size of the read buffer after a read operation.
- Returns false, if an error occurred or the connection dropped.
+ Returns \c false, if an error occurred or the connection dropped.
*/
bool QWindowsPipeReader::completeAsyncRead(DWORD bytesRead, DWORD errorCode)
{
@@ -297,7 +297,7 @@ DWORD QWindowsPipeReader::checkPipeState()
/*!
Waits for the completion of the asynchronous read operation.
- Returns true, if we've emitted the readyRead signal.
+ Returns \c true, if we've emitted the readyRead signal.
*/
bool QWindowsPipeReader::waitForReadyRead(int msecs)
{