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/qregion.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/qregion.cpp')
-rw-r--r-- | src/gui/painting/qregion.cpp | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/src/gui/painting/qregion.cpp b/src/gui/painting/qregion.cpp index 913daee3e1..f58cd1c428 100644 --- a/src/gui/painting/qregion.cpp +++ b/src/gui/painting/qregion.cpp @@ -591,8 +591,8 @@ QRegion& QRegion::operator^=(const QRegion &r) /*! \fn bool QRegion::operator!=(const QRegion &other) const - Returns true if this region is different from the \a other region; - otherwise returns false. + Returns \c true if this region is different from the \a other region; + otherwise returns \c false. */ /*! @@ -606,7 +606,7 @@ QRegion::operator QVariant() const /*! \fn bool QRegion::operator==(const QRegion &r) const - Returns true if the region is equal to \a r; otherwise returns + Returns \c true if the region is equal to \a r; otherwise returns false. */ @@ -659,8 +659,8 @@ inline bool rect_intersects(const QRect &r1, const QRect &r2) /*! \since 4.2 - Returns true if this region intersects with \a region, otherwise - returns false. + Returns \c true if this region intersects with \a region, otherwise + returns \c false. */ bool QRegion::intersects(const QRegion ®ion) const { @@ -686,8 +686,8 @@ bool QRegion::intersects(const QRegion ®ion) const \fn bool QRegion::intersects(const QRect &rect) const \since 4.2 - Returns true if this region intersects with \a rect, otherwise - returns false. + Returns \c true if this region intersects with \a rect, otherwise + returns \c false. */ @@ -712,7 +712,7 @@ QRegion QRegion::intersect(const QRect &r) const /*! \fn bool QRegion::isEmpty() const - Returns true if the region is empty; otherwise returns false. An + Returns \c true if the region is empty; otherwise returns \c false. An empty region is a region that contains no points. Example: @@ -723,7 +723,7 @@ QRegion QRegion::intersect(const QRect &r) const \fn bool QRegion::isNull() const \since 5.0 - Returns true if the region is empty; otherwise returns false. An + Returns \c true if the region is empty; otherwise returns \c false. An empty region is a region that contains no points. This function is the same as isEmpty @@ -733,16 +733,16 @@ QRegion QRegion::intersect(const QRect &r) const /*! \fn bool QRegion::contains(const QPoint &p) const - Returns true if the region contains the point \a p; otherwise - returns false. + Returns \c true if the region contains the point \a p; otherwise + returns \c false. */ /*! \fn bool QRegion::contains(const QRect &r) const \overload - Returns true if the region overlaps the rectangle \a r; otherwise - returns false. + Returns \c true if the region overlaps the rectangle \a r; otherwise + returns \c false. */ /*! @@ -1099,7 +1099,7 @@ struct QRegionPrivate { void intersect(const QRect &r); /* - * Returns true if r is guaranteed to be fully contained in this region. + * Returns \c true if r is guaranteed to be fully contained in this region. * A false return value does not guarantee the opposite. */ inline bool contains(const QRegionPrivate &r) const { @@ -1113,7 +1113,7 @@ struct QRegionPrivate { } /* - * Returns true if this region is guaranteed to be fully contained in r. + * Returns \c true if this region is guaranteed to be fully contained in r. */ inline bool within(const QRect &r1) const { const QRect &r2 = extents; @@ -4167,7 +4167,7 @@ QRect QRegion::boundingRect() const } /*! \internal - Returns true if \a rect is guaranteed to be fully contained in \a region. + Returns \c true if \a rect is guaranteed to be fully contained in \a region. A false return value does not guarantee the opposite. */ Q_GUI_EXPORT |