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/corelib/io/qdiriterator.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/corelib/io/qdiriterator.cpp')
-rw-r--r-- | src/corelib/io/qdiriterator.cpp | 6 |
1 files changed, 3 insertions, 3 deletions
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() |