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/qvector3d.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/qvector3d.cpp')
-rw-r--r-- | src/gui/math3d/qvector3d.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/gui/math3d/qvector3d.cpp b/src/gui/math3d/qvector3d.cpp index 226483c227..7e3ed7c61b 100644 --- a/src/gui/math3d/qvector3d.cpp +++ b/src/gui/math3d/qvector3d.cpp @@ -144,8 +144,8 @@ QVector3D::QVector3D(const QVector4D& vector) /*! \fn bool QVector3D::isNull() const - Returns true if the x, y, and z coordinates are set to 0.0, - otherwise returns false. + Returns \c true if the x, y, and z coordinates are set to 0.0, + otherwise returns \c false. */ /*! @@ -438,7 +438,7 @@ float QVector3D::distanceToLine \fn bool operator==(const QVector3D &v1, const QVector3D &v2) \relates QVector3D - Returns true if \a v1 is equal to \a v2; otherwise returns false. + Returns \c true if \a v1 is equal to \a v2; otherwise returns \c false. This operator uses an exact floating-point comparison. */ @@ -446,7 +446,7 @@ float QVector3D::distanceToLine \fn bool operator!=(const QVector3D &v1, const QVector3D &v2) \relates QVector3D - Returns true if \a v1 is not equal to \a v2; otherwise returns false. + Returns \c true if \a v1 is not equal to \a v2; otherwise returns \c false. This operator uses an exact floating-point comparison. */ @@ -524,7 +524,7 @@ float QVector3D::distanceToLine \fn bool qFuzzyCompare(const QVector3D& v1, const QVector3D& v2) \relates QVector3D - Returns true if \a v1 and \a v2 are equal, allowing for a small + Returns \c true if \a v1 and \a v2 are equal, allowing for a small fuzziness factor for floating-point comparisons; false otherwise. */ |