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/tools/qvector.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/tools/qvector.cpp')
| -rw-r--r-- | src/corelib/tools/qvector.cpp | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/src/corelib/tools/qvector.cpp b/src/corelib/tools/qvector.cpp index 8982e797d9..69b656c191 100644 --- a/src/corelib/tools/qvector.cpp +++ b/src/corelib/tools/qvector.cpp @@ -272,8 +272,8 @@ /*! \fn bool QVector::operator==(const QVector<T> &other) const - Returns true if \a other is equal to this vector; otherwise - returns false. + Returns \c true if \a other is equal to this vector; otherwise + returns \c false. Two vectors are considered equal if they contain the same values in the same order. @@ -286,8 +286,8 @@ /*! \fn bool QVector::operator!=(const QVector<T> &other) const - Returns true if \a other is not equal to this vector; otherwise - returns false. + Returns \c true if \a other is not equal to this vector; otherwise + returns \c false. Two vectors are considered equal if they contain the same values in the same order. @@ -307,7 +307,7 @@ /*! \fn bool QVector::isEmpty() const - Returns true if the vector has size 0; otherwise returns false. + Returns \c true if the vector has size 0; otherwise returns \c false. \sa size(), resize() */ @@ -649,8 +649,8 @@ /*! \fn bool QVector::contains(const T &value) const - Returns true if the vector contains an occurrence of \a value; - otherwise returns false. + Returns \c true if the vector contains an occurrence of \a value; + otherwise returns \c false. This function requires the value type to have an implementation of \c operator==(). @@ -661,8 +661,8 @@ /*! \fn bool QVector::startsWith(const T &value) const \since 4.5 - Returns true if this vector is not empty and its first - item is equal to \a value; otherwise returns false. + Returns \c true if this vector is not empty and its first + item is equal to \a value; otherwise returns \c false. \sa isEmpty(), first() */ @@ -670,8 +670,8 @@ /*! \fn bool QVector::endsWith(const T &value) const \since 4.5 - Returns true if this vector is not empty and its last - item is equal to \a value; otherwise returns false. + Returns \c true if this vector is not empty and its last + item is equal to \a value; otherwise returns \c false. \sa isEmpty(), last() */ @@ -868,7 +868,7 @@ This function is provided for STL compatibility. It is equivalent to isEmpty(), returning true if the vector is empty; otherwise - returns false. + returns \c false. */ /*! \fn QVector<T> &QVector::operator+=(const QVector<T> &other) |