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/qvector2d.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/qvector2d.cpp')
-rw-r--r-- | src/gui/math3d/qvector2d.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/gui/math3d/qvector2d.cpp b/src/gui/math3d/qvector2d.cpp index 7446d27dab..a56e23eb72 100644 --- a/src/gui/math3d/qvector2d.cpp +++ b/src/gui/math3d/qvector2d.cpp @@ -124,8 +124,8 @@ QVector2D::QVector2D(const QVector4D& vector) /*! \fn bool QVector2D::isNull() const - Returns true if the x and y coordinates are set to 0.0, - otherwise returns false. + Returns \c true if the x and y coordinates are set to 0.0, + otherwise returns \c false. */ /*! @@ -335,7 +335,7 @@ float QVector2D::dotProduct(const QVector2D& v1, const QVector2D& v2) \fn bool operator==(const QVector2D &v1, const QVector2D &v2) \relates QVector2D - 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. */ @@ -343,7 +343,7 @@ float QVector2D::dotProduct(const QVector2D& v1, const QVector2D& v2) \fn bool operator!=(const QVector2D &v1, const QVector2D &v2) \relates QVector2D - 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. */ @@ -418,7 +418,7 @@ float QVector2D::dotProduct(const QVector2D& v1, const QVector2D& v2) \fn bool qFuzzyCompare(const QVector2D& v1, const QVector2D& v2) \relates QVector2D - 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. */ |