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/gui/painting/qmatrix.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/gui/painting/qmatrix.cpp')
-rw-r--r-- | src/gui/painting/qmatrix.cpp | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/src/gui/painting/qmatrix.cpp b/src/gui/painting/qmatrix.cpp index fe09e5568d..c44c89c8ee 100644 --- a/src/gui/painting/qmatrix.cpp +++ b/src/gui/painting/qmatrix.cpp @@ -82,9 +82,9 @@ QT_BEGIN_NAMESPACE transformed into a \e polygon (mapped to the coordinate system defined by \e this matrix), using the mapToPolygon() function. - QMatrix provides the isIdentity() function which returns true if + QMatrix provides the isIdentity() function which returns \c true if the matrix is the identity matrix, and the isInvertible() function - which returns true if the matrix is non-singular (i.e. AB = BA = + which returns \c true if the matrix is non-singular (i.e. AB = BA = I). The inverted() function returns an inverted copy of \e this matrix if it is invertible (otherwise it returns the identity matrix). In addition, QMatrix provides the determinant() function @@ -817,8 +817,8 @@ void QMatrix::reset() /*! \fn bool QMatrix::isIdentity() const - Returns true if the matrix is the identity matrix, otherwise - returns false. + Returns \c true if the matrix is the identity matrix, otherwise + returns \c false. \sa reset() */ @@ -919,7 +919,7 @@ QMatrix &QMatrix::rotate(qreal a) /*! \fn bool QMatrix::isInvertible() const - Returns true if the matrix is invertible, otherwise returns false. + Returns \c true if the matrix is invertible, otherwise returns \c false. \sa inverted() */ @@ -966,8 +966,8 @@ QMatrix QMatrix::inverted(bool *invertible) const /*! \fn bool QMatrix::operator==(const QMatrix &matrix) const - Returns true if this matrix is equal to the given \a matrix, - otherwise returns false. + Returns \c true if this matrix is equal to the given \a matrix, + otherwise returns \c false. */ bool QMatrix::operator==(const QMatrix &m) const @@ -983,8 +983,8 @@ bool QMatrix::operator==(const QMatrix &m) const /*! \fn bool QMatrix::operator!=(const QMatrix &matrix) const - Returns true if this matrix is not equal to the given \a matrix, - otherwise returns false. + Returns \c true if this matrix is not equal to the given \a matrix, + otherwise returns \c false. */ bool QMatrix::operator!=(const QMatrix &m) const @@ -1159,7 +1159,7 @@ QDebug operator<<(QDebug dbg, const QMatrix &m) \brief The qFuzzyCompare function is for comparing two matrices using a fuzziness factor. - Returns true if \a m1 and \a m2 are equal, allowing for a small + Returns \c true if \a m1 and \a m2 are equal, allowing for a small fuzziness factor for floating-point comparisons; false otherwise. */ |