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/math3d/qquaternion.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/math3d/qquaternion.cpp')
| -rw-r--r-- | src/gui/math3d/qquaternion.cpp | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/src/gui/math3d/qquaternion.cpp b/src/gui/math3d/qquaternion.cpp index d042d9812a..d721674eb6 100644 --- a/src/gui/math3d/qquaternion.cpp +++ b/src/gui/math3d/qquaternion.cpp @@ -133,16 +133,16 @@ QT_BEGIN_NAMESPACE /*! \fn bool QQuaternion::isNull() const - Returns true if the x, y, z, and scalar components of this - quaternion are set to 0.0; otherwise returns false. + Returns \c true if the x, y, z, and scalar components of this + quaternion are set to 0.0; otherwise returns \c false. */ /*! \fn bool QQuaternion::isIdentity() const - Returns true if the x, y, and z components of this + Returns \c true if the x, y, and z components of this quaternion are set to 0.0, and the scalar component is set - to 1.0; otherwise returns false. + to 1.0; otherwise returns \c false. */ /*! @@ -394,7 +394,7 @@ QQuaternion QQuaternion::fromAxisAndAngle \fn bool operator==(const QQuaternion &q1, const QQuaternion &q2) \relates QQuaternion - Returns true if \a q1 is equal to \a q2; otherwise returns false. + Returns \c true if \a q1 is equal to \a q2; otherwise returns \c false. This operator uses an exact floating-point comparison. */ @@ -402,7 +402,7 @@ QQuaternion QQuaternion::fromAxisAndAngle \fn bool operator!=(const QQuaternion &q1, const QQuaternion &q2) \relates QQuaternion - Returns true if \a q1 is not equal to \a q2; otherwise returns false. + Returns \c true if \a q1 is not equal to \a q2; otherwise returns \c false. This operator uses an exact floating-point comparison. */ @@ -482,7 +482,7 @@ QQuaternion QQuaternion::fromAxisAndAngle \fn bool qFuzzyCompare(const QQuaternion& q1, const QQuaternion& q2) \relates QQuaternion - Returns true if \a q1 and \a q2 are equal, allowing for a small + Returns \c true if \a q1 and \a q2 are equal, allowing for a small fuzziness factor for floating-point comparisons; false otherwise. */ |