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/painting/qpolygon.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/painting/qpolygon.cpp')
-rw-r--r-- | src/gui/painting/qpolygon.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/gui/painting/qpolygon.cpp b/src/gui/painting/qpolygon.cpp index 34215b53b0..ef8fc28f12 100644 --- a/src/gui/painting/qpolygon.cpp +++ b/src/gui/painting/qpolygon.cpp @@ -642,7 +642,7 @@ QPolygonF QPolygonF::translated(const QPointF &offset) const /*! \fn bool QPolygonF::isClosed() const - Returns true if the polygon is closed; otherwise returns false. + Returns \c true if the polygon is closed; otherwise returns \c false. A polygon is said to be closed if its start point and end point are equal. @@ -824,8 +824,8 @@ QDebug operator<<(QDebug dbg, const QPolygonF &a) \fn bool QPolygonF::containsPoint(const QPointF &point, Qt::FillRule fillRule) const - Returns true if the given \a point is inside the polygon according to - the specified \a fillRule; otherwise returns false. + Returns \c true if the given \a point is inside the polygon according to + the specified \a fillRule; otherwise returns \c false. */ bool QPolygonF::containsPoint(const QPointF &pt, Qt::FillRule fillRule) const { @@ -855,8 +855,8 @@ bool QPolygonF::containsPoint(const QPointF &pt, Qt::FillRule fillRule) const \since 4.3 \fn bool QPolygon::containsPoint(const QPoint &point, Qt::FillRule fillRule) const - Returns true if the given \a point is inside the polygon according to - the specified \a fillRule; otherwise returns false. + Returns \c true if the given \a point is inside the polygon according to + the specified \a fillRule; otherwise returns \c false. */ bool QPolygon::containsPoint(const QPoint &pt, Qt::FillRule fillRule) const { |