From 4533cc994484a2308297e64e99af005fb4dca065 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 2 Oct 2013 16:51:05 +0200 Subject: 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 Reviewed-by: Jerome Pasion --- src/gui/math3d/qmatrix4x4.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'src/gui/math3d/qmatrix4x4.cpp') diff --git a/src/gui/math3d/qmatrix4x4.cpp b/src/gui/math3d/qmatrix4x4.cpp index 11132e84bb..0b3c5b4cb9 100644 --- a/src/gui/math3d/qmatrix4x4.cpp +++ b/src/gui/math3d/qmatrix4x4.cpp @@ -300,7 +300,7 @@ QMatrix4x4::QMatrix4x4(const QTransform& transform) /*! \fn bool QMatrix4x4::isIdentity() const - Returns true if this matrix is the identity; false otherwise. + Returns \c true if this matrix is the identity; false otherwise. \sa setToIdentity() */ @@ -634,14 +634,14 @@ QMatrix4x4& QMatrix4x4::operator/=(float divisor) /*! \fn bool QMatrix4x4::operator==(const QMatrix4x4& other) const - Returns true if this matrix is identical to \a other; false otherwise. + Returns \c true if this matrix is identical to \a other; false otherwise. This operator uses an exact floating-point comparison. */ /*! \fn bool QMatrix4x4::operator!=(const QMatrix4x4& other) const - Returns true if this matrix is not identical to \a other; false otherwise. + Returns \c true if this matrix is not identical to \a other; false otherwise. This operator uses an exact floating-point comparison. */ @@ -792,7 +792,7 @@ QMatrix4x4 operator/(const QMatrix4x4& matrix, float divisor) \fn bool qFuzzyCompare(const QMatrix4x4& m1, const QMatrix4x4& m2) \relates QMatrix4x4 - 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. */ -- cgit v1.2.3