summaryrefslogtreecommitdiffstats
path: root/src/corelib/tools/qpoint.cpp
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2013-10-02 16:51:05 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-08 00:46:27 +0200
commit4533cc994484a2308297e64e99af005fb4dca065 (patch)
treebc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/corelib/tools/qpoint.cpp
parent50dd0232b61d8ea3fb9aab18972c6e19678656e6 (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/corelib/tools/qpoint.cpp')
-rw-r--r--src/corelib/tools/qpoint.cpp20
1 files changed, 10 insertions, 10 deletions
diff --git a/src/corelib/tools/qpoint.cpp b/src/corelib/tools/qpoint.cpp
index 784d96bf1c..565b1223fe 100644
--- a/src/corelib/tools/qpoint.cpp
+++ b/src/corelib/tools/qpoint.cpp
@@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE
A point is specified by a x coordinate and an y coordinate which
can be accessed using the x() and y() functions. The isNull()
- function returns true if both x and y are set to 0. The
+ function returns \c true if both x and y are set to 0. The
coordinates can be set (or altered) using the setX() and setY()
functions, or alternatively the rx() and ry() functions which
return references to the coordinates (allowing direct
@@ -102,8 +102,8 @@ QT_BEGIN_NAMESPACE
/*!
\fn bool QPoint::isNull() const
- Returns true if both the x and y coordinates are set to 0,
- otherwise returns false.
+ Returns \c true if both the x and y coordinates are set to 0,
+ otherwise returns \c false.
*/
/*!
@@ -235,7 +235,7 @@ QT_BEGIN_NAMESPACE
\fn bool operator==(const QPoint &p1, const QPoint &p2)
\relates QPoint
- Returns true if \a p1 and \a p2 are equal; otherwise returns
+ Returns \c true if \a p1 and \a p2 are equal; otherwise returns
false.
*/
@@ -243,7 +243,7 @@ QT_BEGIN_NAMESPACE
\fn bool operator!=(const QPoint &p1, const QPoint &p2)
\relates QPoint
- Returns true if \a p1 and \a p2 are not equal; otherwise returns false.
+ Returns \c true if \a p1 and \a p2 are not equal; otherwise returns \c false.
*/
/*!
@@ -474,7 +474,7 @@ QDebug operator<<(QDebug d, const QPointF &p)
A point is specified by a x coordinate and an y coordinate which
can be accessed using the x() and y() functions. The coordinates
of the point are specified using floating point numbers for
- accuracy. The isNull() function returns true if both x and y are
+ accuracy. The isNull() function returns \c true if both x and y are
set to 0.0. The coordinates can be set (or altered) using the setX()
and setY() functions, or alternatively the rx() and ry() functions which
return references to the coordinates (allowing direct
@@ -524,8 +524,8 @@ QDebug operator<<(QDebug d, const QPointF &p)
/*!
\fn bool QPointF::isNull() const
- Returns true if both the x and y coordinates are set to +0.0;
- otherwise returns false.
+ Returns \c true if both the x and y coordinates are set to +0.0;
+ otherwise returns \c false.
\note Since this function treats +0.0 and -0.0 differently, points
with zero-valued coordinates where either or both values have a
@@ -733,14 +733,14 @@ QDebug operator<<(QDebug d, const QPointF &p)
\fn bool operator==(const QPointF &p1, const QPointF &p2)
\relates QPointF
- Returns true if \a p1 is equal to \a p2; otherwise returns false.
+ Returns \c true if \a p1 is equal to \a p2; otherwise returns \c false.
*/
/*!
\fn bool operator!=(const QPointF &p1, const QPointF &p2);
\relates QPointF
- Returns true if \a p1 is not equal to \a p2; otherwise returns false.
+ Returns \c true if \a p1 is not equal to \a p2; otherwise returns \c false.
*/
#ifndef QT_NO_DATASTREAM