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/qbitarray.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/qbitarray.cpp')
| -rw-r--r-- | src/corelib/tools/qbitarray.cpp | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/src/corelib/tools/qbitarray.cpp b/src/corelib/tools/qbitarray.cpp index 4f1fce3077..f583444d3c 100644 --- a/src/corelib/tools/qbitarray.cpp +++ b/src/corelib/tools/qbitarray.cpp @@ -262,7 +262,7 @@ void QBitArray::resize(int size) /*! \fn bool QBitArray::isEmpty() const - Returns true if this bit array has size 0; otherwise returns + Returns \c true if this bit array has size 0; otherwise returns false. \sa size() @@ -270,7 +270,7 @@ void QBitArray::resize(int size) /*! \fn bool QBitArray::isNull() const - Returns true if this bit array is null; otherwise returns false. + Returns \c true if this bit array is null; otherwise returns \c false. Example: \snippet code/src_corelib_tools_qbitarray.cpp 5 @@ -286,7 +286,7 @@ void QBitArray::resize(int size) /*! \fn bool QBitArray::fill(bool value, int size = -1) Sets every bit in the bit array to \a value, returning true if successful; - otherwise returns false. If \a size is different from -1 (the default), + otherwise returns \c false. If \a size is different from -1 (the default), the bit array is resized to \a size beforehand. Example: @@ -363,8 +363,8 @@ void QBitArray::fill(bool value, int begin, int end) /*! \fn bool QBitArray::testBit(int i) const - Returns true if the bit at index position \a i is 1; otherwise - returns false. + Returns \c true if the bit at index position \a i is 1; otherwise + returns \c false. \a i must be a valid index position in the bit array (i.e., 0 <= \a i < size()). @@ -478,16 +478,16 @@ void QBitArray::fill(bool value, int begin, int end) /*! \fn bool QBitArray::operator==(const QBitArray &other) const - Returns true if \a other is equal to this bit array; otherwise - returns false. + Returns \c true if \a other is equal to this bit array; otherwise + returns \c false. \sa operator!=() */ /*! \fn bool QBitArray::operator!=(const QBitArray &other) const - Returns true if \a other is not equal to this bit array; - otherwise returns false. + Returns \c true if \a other is not equal to this bit array; + otherwise returns \c false. \sa operator==() */ |