summaryrefslogtreecommitdiffstats
path: root/src/gui/painting
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/gui/painting
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/gui/painting')
-rw-r--r--src/gui/painting/qbackingstore.cpp2
-rw-r--r--src/gui/painting/qbrush.cpp20
-rw-r--r--src/gui/painting/qcolor.cpp12
-rw-r--r--src/gui/painting/qmatrix.cpp20
-rw-r--r--src/gui/painting/qpaintdevice.qdoc4
-rw-r--r--src/gui/painting/qpaintengine.cpp10
-rw-r--r--src/gui/painting/qpaintengine_raster.cpp2
-rw-r--r--src/gui/painting/qpainter.cpp20
-rw-r--r--src/gui/painting/qpainterpath.cpp46
-rw-r--r--src/gui/painting/qpen.cpp8
-rw-r--r--src/gui/painting/qplatformbackingstore.cpp2
-rw-r--r--src/gui/painting/qpolygon.cpp10
-rw-r--r--src/gui/painting/qregion.cpp32
-rw-r--r--src/gui/painting/qstroker.cpp2
-rw-r--r--src/gui/painting/qtransform.cpp42
15 files changed, 116 insertions, 116 deletions
diff --git a/src/gui/painting/qbackingstore.cpp b/src/gui/painting/qbackingstore.cpp
index 3a36762502..c44be64fb1 100644
--- a/src/gui/painting/qbackingstore.cpp
+++ b/src/gui/painting/qbackingstore.cpp
@@ -194,7 +194,7 @@ QSize QBackingStore::size() const
Scrolls the given \a area \a dx pixels to the right and \a dy
downward; both \a dx and \a dy may be negative.
- Returns true if the area was scrolled successfully; false otherwise.
+ Returns \c true if the area was scrolled successfully; false otherwise.
*/
bool QBackingStore::scroll(const QRegion &area, int dx, int dy)
{
diff --git a/src/gui/painting/qbrush.cpp b/src/gui/painting/qbrush.cpp
index 4ec47fa4a9..d8dfae1e2c 100644
--- a/src/gui/painting/qbrush.cpp
+++ b/src/gui/painting/qbrush.cpp
@@ -306,7 +306,7 @@ struct QBrushDataPointerDeleter
the style is a gradient. The same is the case if the style is
Qt::TexturePattern style unless the current texture is a QBitmap.
- The isOpaque() function returns true if the brush is fully opaque
+ The isOpaque() function returns \c true if the brush is fully opaque
otherwise false. A brush is considered opaque if:
\list
@@ -830,7 +830,7 @@ Q_GUI_EXPORT bool qt_isExtendedRadialGradient(const QBrush &brush)
}
/*!
- Returns true if the brush is fully opaque otherwise false. A brush
+ Returns \c true if the brush is fully opaque otherwise false. A brush
is considered opaque if:
\list
@@ -912,8 +912,8 @@ void QBrush::setTransform(const QTransform &matrix)
/*!
\fn bool QBrush::operator!=(const QBrush &brush) const
- Returns true if the brush is different from the given \a brush;
- otherwise returns false.
+ Returns \c true if the brush is different from the given \a brush;
+ otherwise returns \c false.
Two brushes are different if they have different styles, colors or
transforms or different pixmaps or gradients depending on the style.
@@ -924,8 +924,8 @@ void QBrush::setTransform(const QTransform &matrix)
/*!
\fn bool QBrush::operator==(const QBrush &brush) const
- Returns true if the brush is equal to the given \a brush;
- otherwise returns false.
+ Returns \c true if the brush is equal to the given \a brush;
+ otherwise returns \c false.
Two brushes are equal if they have equal styles, colors and
transforms and equal pixmaps or gradients depending on the style.
@@ -1491,15 +1491,15 @@ void QGradient::setInterpolationMode(InterpolationMode mode)
\fn bool QGradient::operator!=(const QGradient &gradient) const
\since 4.2
- Returns true if the gradient is the same as the other \a gradient
- specified; otherwise returns false.
+ Returns \c true if the gradient is the same as the other \a gradient
+ specified; otherwise returns \c false.
\sa operator==()
*/
/*!
- Returns true if the gradient is the same as the other \a gradient
- specified; otherwise returns false.
+ Returns \c true if the gradient is the same as the other \a gradient
+ specified; otherwise returns \c false.
\sa operator!=()
*/
diff --git a/src/gui/painting/qcolor.cpp b/src/gui/painting/qcolor.cpp
index c93320c491..706273c151 100644
--- a/src/gui/painting/qcolor.cpp
+++ b/src/gui/painting/qcolor.cpp
@@ -489,7 +489,7 @@ QColor::QColor(Spec spec)
/*!
\fn bool QColor::isValid() const
- Returns true if the color is valid; otherwise returns false.
+ Returns \c true if the color is valid; otherwise returns \c false.
*/
/*!
@@ -557,7 +557,7 @@ void QColor::setNamedColor(const QString &name)
/*!
\since 4.7
- Returns true if the \a name is a valid color name and can
+ Returns \c true if the \a name is a valid color name and can
be used to construct a valid QColor object, otherwise returns
false.
@@ -2338,8 +2338,8 @@ QColor &QColor::operator=(Qt::GlobalColor color)
}
/*!
- Returns true if this color has the same RGB and alpha values as \a color;
- otherwise returns false.
+ Returns \c true if this color has the same RGB and alpha values as \a color;
+ otherwise returns \c false.
*/
bool QColor::operator==(const QColor &color) const
{
@@ -2366,8 +2366,8 @@ bool QColor::operator==(const QColor &color) const
}
/*!
- Returns true if this color has a different RGB and alpha values from
- \a color; otherwise returns false.
+ Returns \c true if this color has a different RGB and alpha values from
+ \a color; otherwise returns \c false.
*/
bool QColor::operator!=(const QColor &color) const
{ return !operator==(color); }
diff --git a/src/gui/painting/qmatrix.cpp b/src/gui/painting/qmatrix.cpp
index fe09e5568d..c44c89c8ee 100644
--- a/src/gui/painting/qmatrix.cpp
+++ b/src/gui/painting/qmatrix.cpp
@@ -82,9 +82,9 @@ QT_BEGIN_NAMESPACE
transformed into a \e polygon (mapped to the coordinate system
defined by \e this matrix), using the mapToPolygon() function.
- QMatrix provides the isIdentity() function which returns true if
+ QMatrix provides the isIdentity() function which returns \c true if
the matrix is the identity matrix, and the isInvertible() function
- which returns true if the matrix is non-singular (i.e. AB = BA =
+ which returns \c true if the matrix is non-singular (i.e. AB = BA =
I). The inverted() function returns an inverted copy of \e this
matrix if it is invertible (otherwise it returns the identity
matrix). In addition, QMatrix provides the determinant() function
@@ -817,8 +817,8 @@ void QMatrix::reset()
/*!
\fn bool QMatrix::isIdentity() const
- Returns true if the matrix is the identity matrix, otherwise
- returns false.
+ Returns \c true if the matrix is the identity matrix, otherwise
+ returns \c false.
\sa reset()
*/
@@ -919,7 +919,7 @@ QMatrix &QMatrix::rotate(qreal a)
/*!
\fn bool QMatrix::isInvertible() const
- Returns true if the matrix is invertible, otherwise returns false.
+ Returns \c true if the matrix is invertible, otherwise returns \c false.
\sa inverted()
*/
@@ -966,8 +966,8 @@ QMatrix QMatrix::inverted(bool *invertible) const
/*!
\fn bool QMatrix::operator==(const QMatrix &matrix) const
- Returns true if this matrix is equal to the given \a matrix,
- otherwise returns false.
+ Returns \c true if this matrix is equal to the given \a matrix,
+ otherwise returns \c false.
*/
bool QMatrix::operator==(const QMatrix &m) const
@@ -983,8 +983,8 @@ bool QMatrix::operator==(const QMatrix &m) const
/*!
\fn bool QMatrix::operator!=(const QMatrix &matrix) const
- Returns true if this matrix is not equal to the given \a matrix,
- otherwise returns false.
+ Returns \c true if this matrix is not equal to the given \a matrix,
+ otherwise returns \c false.
*/
bool QMatrix::operator!=(const QMatrix &m) const
@@ -1159,7 +1159,7 @@ QDebug operator<<(QDebug dbg, const QMatrix &m)
\brief The qFuzzyCompare function is for comparing two matrices
using a fuzziness factor.
- Returns true if \a m1 and \a m2 are equal, allowing for a small
+ Returns \c true if \a m1 and \a m2 are equal, allowing for a small
fuzziness factor for floating-point comparisons; false otherwise.
*/
diff --git a/src/gui/painting/qpaintdevice.qdoc b/src/gui/painting/qpaintdevice.qdoc
index 993b23850e..150ba10955 100644
--- a/src/gui/painting/qpaintdevice.qdoc
+++ b/src/gui/painting/qpaintdevice.qdoc
@@ -149,9 +149,9 @@
/*!
\fn bool QPaintDevice::paintingActive() const
- Returns true if the device is currently being painted on, i.e. someone has
+ Returns \c true if the device is currently being painted on, i.e. someone has
called QPainter::begin() but not yet called QPainter::end() for
- this device; otherwise returns false.
+ this device; otherwise returns \c false.
\sa QPainter::isActive()
*/
diff --git a/src/gui/painting/qpaintengine.cpp b/src/gui/painting/qpaintengine.cpp
index aa175c2d65..f1eaea0f6b 100644
--- a/src/gui/painting/qpaintengine.cpp
+++ b/src/gui/painting/qpaintengine.cpp
@@ -392,8 +392,8 @@ void QPaintEngine::drawPolygon(const QPoint *points, int pointCount, PolygonDraw
/*!
\fn bool QPaintEngine::isActive() const
- Returns true if the paint engine is actively drawing; otherwise
- returns false.
+ Returns \c true if the paint engine is actively drawing; otherwise
+ returns \c false.
\sa setActive()
*/
@@ -657,8 +657,8 @@ void QPaintEngine::drawImage(const QRectF &r, const QImage &image, const QRectF
/*!
\fn bool QPaintEngine::hasFeature(PaintEngineFeatures feature) const
- Returns true if the paint engine supports the specified \a
- feature; otherwise returns false.
+ Returns \c true if the paint engine supports the specified \a
+ feature; otherwise returns \c false.
*/
/*!
@@ -666,7 +666,7 @@ void QPaintEngine::drawImage(const QRectF &r, const QImage &image, const QRectF
\internal
- Returns true if the paint engine is a QPaintEngineEx derivative.
+ Returns \c true if the paint engine is a QPaintEngineEx derivative.
*/
/*!
diff --git a/src/gui/painting/qpaintengine_raster.cpp b/src/gui/painting/qpaintengine_raster.cpp
index 824dbf7ae8..4a26da104d 100644
--- a/src/gui/painting/qpaintengine_raster.cpp
+++ b/src/gui/painting/qpaintengine_raster.cpp
@@ -2887,7 +2887,7 @@ bool QRasterPaintEngine::drawCachedGlyphs(int numGlyphs, const glyph_t *glyphs,
/*!
- * Returns true if the rectangle is completely within the current clip
+ * Returns \c true if the rectangle is completely within the current clip
* state of the paint engine.
*/
bool QRasterPaintEnginePrivate::isUnclipped_normalized(const QRect &r) const
diff --git a/src/gui/painting/qpainter.cpp b/src/gui/painting/qpainter.cpp
index b315017d6d..4c02abdfd5 100644
--- a/src/gui/painting/qpainter.cpp
+++ b/src/gui/painting/qpainter.cpp
@@ -241,7 +241,7 @@ QTransform QPainterPrivate::hidpiScaleTransform() const
/*
\internal
- Returns true if using a shared painter; otherwise false.
+ Returns \c true if using a shared painter; otherwise false.
*/
bool QPainterPrivate::attachPainterPrivate(QPainter *q, QPaintDevice *pdev)
{
@@ -1510,8 +1510,8 @@ QPaintDevice *QPainter::device() const
}
/*!
- Returns true if begin() has been called and end() has not yet been
- called; otherwise returns false.
+ Returns \c true if begin() has been called and end() has not yet been
+ called; otherwise returns \c false.
\sa begin(), QPaintDevice::paintingActive()
*/
@@ -1660,8 +1660,8 @@ void QPainter::restore()
\fn bool QPainter::begin(QPaintDevice *device)
- Begins painting the paint \a device and returns true if
- successful; otherwise returns false.
+ Begins painting the paint \a device and returns \c true if
+ successful; otherwise returns \c false.
Notice that all painter settings (setPen(), setBrush() etc.) are reset
to default values when begin() is called.
@@ -1856,7 +1856,7 @@ bool QPainter::begin(QPaintDevice *pd)
don't normally need to call this since it is called by the
destructor.
- Returns true if the painter is no longer active; otherwise returns false.
+ Returns \c true if the painter is no longer active; otherwise returns \c false.
\sa begin(), isActive()
*/
@@ -2420,7 +2420,7 @@ const QBrush &QPainter::background() const
/*!
- Returns true if clipping has been set; otherwise returns false.
+ Returns \c true if clipping has been set; otherwise returns \c false.
\sa setClipping(), {QPainter#Clipping}{Clipping}
*/
@@ -3058,7 +3058,7 @@ void QPainter::setWorldMatrixEnabled(bool enable)
/*!
\since 4.2
- Returns true if world transformation is enabled; otherwise returns
+ Returns \c true if world transformation is enabled; otherwise returns
false.
\sa setWorldMatrixEnabled(), worldTransform(), {Coordinate System}
@@ -7078,13 +7078,13 @@ QPainter::RenderHints QPainter::renderHints() const
\fn bool QPainter::testRenderHint(RenderHint hint) const
\since 4.3
- Returns true if \a hint is set; otherwise returns false.
+ Returns \c true if \a hint is set; otherwise returns \c false.
\sa renderHints(), setRenderHint()
*/
/*!
- Returns true if view transformation is enabled; otherwise returns
+ Returns \c true if view transformation is enabled; otherwise returns
false.
\sa setViewTransformEnabled(), worldTransform()
diff --git a/src/gui/painting/qpainterpath.cpp b/src/gui/painting/qpainterpath.cpp
index 1e36cd224a..156e411154 100644
--- a/src/gui/painting/qpainterpath.cpp
+++ b/src/gui/painting/qpainterpath.cpp
@@ -395,8 +395,8 @@ static void qt_debug_path(const QPainterPath &path)
\fn bool QPainterPath::Element::operator==(const Element &other) const
\since 4.2
- Returns true if this element is equal to \a other;
- otherwise returns false.
+ Returns \c true if this element is equal to \a other;
+ otherwise returns \c false.
\sa operator!=()
*/
@@ -405,8 +405,8 @@ static void qt_debug_path(const QPainterPath &path)
\fn bool QPainterPath::Element::operator!=(const Element &other) const
\since 4.2
- Returns true if this element is not equal to \a other;
- otherwise returns false.
+ Returns \c true if this element is not equal to \a other;
+ otherwise returns \c false.
\sa operator==()
*/
@@ -414,7 +414,7 @@ static void qt_debug_path(const QPainterPath &path)
/*!
\fn bool QPainterPath::Element::isCurveTo () const
- Returns true if the element is a curve, otherwise returns false.
+ Returns \c true if the element is a curve, otherwise returns \c false.
\sa type, QPainterPath::CurveToElement
*/
@@ -422,7 +422,7 @@ static void qt_debug_path(const QPainterPath &path)
/*!
\fn bool QPainterPath::Element::isLineTo () const
- Returns true if the element is a line, otherwise returns false.
+ Returns \c true if the element is a line, otherwise returns \c false.
\sa type, QPainterPath::LineToElement
*/
@@ -430,8 +430,8 @@ static void qt_debug_path(const QPainterPath &path)
/*!
\fn bool QPainterPath::Element::isMoveTo () const
- Returns true if the element is moving the current position,
- otherwise returns false.
+ Returns \c true if the element is moving the current position,
+ otherwise returns \c false.
\sa type, QPainterPath::MoveToElement
*/
@@ -1485,8 +1485,8 @@ QRectF QPainterPath::controlPointRect() const
/*!
\fn bool QPainterPath::isEmpty() const
- Returns true if either there are no elements in this path, or if the only
- element is a MoveToElement; otherwise returns false.
+ Returns \c true if either there are no elements in this path, or if the only
+ element is a MoveToElement; otherwise returns \c false.
\sa elementCount()
*/
@@ -1806,8 +1806,8 @@ static void qt_painterpath_isect_curve(const QBezier &bezier, const QPointF &pt,
/*!
\fn bool QPainterPath::contains(const QPointF &point) const
- Returns true if the given \a point is inside the path, otherwise
- returns false.
+ Returns \c true if the given \a point is inside the path, otherwise
+ returns \c false.
\sa intersects()
*/
@@ -1982,7 +1982,7 @@ static bool qt_isect_curve_vertical(const QBezier &bezier, qreal x, qreal y1, qr
}
/*
- Returns true if any lines or curves cross the four edges in of rect
+ Returns \c true if any lines or curves cross the four edges in of rect
*/
static bool qt_painterpath_check_crossing(const QPainterPath *path, const QRectF &rect)
{
@@ -2040,8 +2040,8 @@ static bool qt_painterpath_check_crossing(const QPainterPath *path, const QRectF
/*!
\fn bool QPainterPath::intersects(const QRectF &rectangle) const
- Returns true if any point in the given \a rectangle intersects the
- path; otherwise returns false.
+ Returns \c true if any point in the given \a rectangle intersects the
+ path; otherwise returns \c false.
There is an intersection if any of the lines making up the
rectangle crosses a part of the path or if any part of the
@@ -2149,8 +2149,8 @@ QPainterPath QPainterPath::translated(qreal dx, qreal dy) const
/*!
\fn bool QPainterPath::contains(const QRectF &rectangle) const
- Returns true if the given \a rectangle is inside the path,
- otherwise returns false.
+ Returns \c true if the given \a rectangle is inside the path,
+ otherwise returns \c false.
*/
bool QPainterPath::contains(const QRectF &rect) const
{
@@ -2233,7 +2233,7 @@ static inline bool epsilonCompare(const QPointF &a, const QPointF &b, const QSiz
}
/*!
- Returns true if this painterpath is equal to the given \a path.
+ Returns \c true if this painterpath is equal to the given \a path.
Note that comparing paths may involve a per element comparison
which can be slow for complex paths.
@@ -2268,7 +2268,7 @@ bool QPainterPath::operator==(const QPainterPath &path) const
}
/*!
- Returns true if this painter path differs from the given \a path.
+ Returns \c true if this painter path differs from the given \a path.
Note that comparing paths may involve a per element comparison
which can be slow for complex paths.
@@ -3330,8 +3330,8 @@ QPainterPath QPainterPath::simplified() const
/*!
\since 4.3
- Returns true if the current path intersects at any point the given path \a p.
- Also returns true if the current path contains or is contained by any part of \a p.
+ Returns \c true if the current path intersects at any point the given path \a p.
+ Also returns \c true if the current path contains or is contained by any part of \a p.
Set operations on paths will treat the paths as areas. Non-closed
paths will be treated as implicitly closed.
@@ -3351,8 +3351,8 @@ bool QPainterPath::intersects(const QPainterPath &p) const
/*!
\since 4.3
- Returns true if the given path \a p is contained within
- the current path. Returns false if any edges of the current path and
+ Returns \c true if the given path \a p is contained within
+ the current path. Returns \c false if any edges of the current path and
\a p intersect.
Set operations on paths will treat the paths as areas. Non-closed
diff --git a/src/gui/painting/qpen.cpp b/src/gui/painting/qpen.cpp
index a7c4a0eae1..6a3eacd67a 100644
--- a/src/gui/painting/qpen.cpp
+++ b/src/gui/painting/qpen.cpp
@@ -778,7 +778,7 @@ void QPen::setBrush(const QBrush &brush)
/*!
- Returns true if the pen has a solid fill, otherwise false.
+ Returns \c true if the pen has a solid fill, otherwise false.
\sa style(), dashPattern()
*/
@@ -789,7 +789,7 @@ bool QPen::isSolid() const
/*!
- Returns true if the pen is cosmetic; otherwise returns false.
+ Returns \c true if the pen is cosmetic; otherwise returns \c false.
Cosmetic pens are used to draw strokes that have a constant width
regardless of any transformations applied to the QPainter they are
@@ -827,7 +827,7 @@ void QPen::setCosmetic(bool cosmetic)
/*!
\fn bool QPen::operator!=(const QPen &pen) const
- Returns true if the pen is different from the given \a pen;
+ Returns \c true if the pen is different from the given \a pen;
otherwise false. Two pens are different if they have different
styles, widths or colors.
@@ -837,7 +837,7 @@ void QPen::setCosmetic(bool cosmetic)
/*!
\fn bool QPen::operator==(const QPen &pen) const
- Returns true if the pen is equal to the given \a pen; otherwise
+ Returns \c true if the pen is equal to the given \a pen; otherwise
false. Two pens are equal if they have equal styles, widths and
colors.
diff --git a/src/gui/painting/qplatformbackingstore.cpp b/src/gui/painting/qplatformbackingstore.cpp
index 74e9af19ab..feec0c7f3d 100644
--- a/src/gui/painting/qplatformbackingstore.cpp
+++ b/src/gui/painting/qplatformbackingstore.cpp
@@ -135,7 +135,7 @@ void QPlatformBackingStore::endPaint()
Scrolls the given \a area \a dx pixels to the right and \a dy
downward; both \a dx and \a dy may be negative.
- Returns true if the area was scrolled successfully; false otherwise.
+ Returns \c true if the area was scrolled successfully; false otherwise.
*/
bool QPlatformBackingStore::scroll(const QRegion &area, int dx, int dy)
{
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
{
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 &region) const
{
@@ -686,8 +686,8 @@ bool QRegion::intersects(const QRegion &region) 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
diff --git a/src/gui/painting/qstroker.cpp b/src/gui/painting/qstroker.cpp
index 2a5cf49d53..d6ac03fe28 100644
--- a/src/gui/painting/qstroker.cpp
+++ b/src/gui/painting/qstroker.cpp
@@ -627,7 +627,7 @@ void QStroker::joinPoints(qfixed focal_x, qfixed focal_y, const QLineF &nextLine
/*
Strokes a subpath side using the \a it as source. Results are put into
- \a stroke. The function returns true if the subpath side was closed.
+ \a stroke. The function returns \c true if the subpath side was closed.
If \a capFirst is true, we will use capPoints instead of joinPoints to
connect the first segment, other segments will be joined using joinPoints.
This is to put capping in order...
diff --git a/src/gui/painting/qtransform.cpp b/src/gui/painting/qtransform.cpp
index a07b5def5d..30673d90fe 100644
--- a/src/gui/painting/qtransform.cpp
+++ b/src/gui/painting/qtransform.cpp
@@ -125,9 +125,9 @@ QT_BEGIN_NAMESPACE
transformed into a \e polygon (mapped to the coordinate system
defined by \e this matrix), using the mapToPolygon() function.
- QTransform provides the isIdentity() function which returns true if
+ QTransform provides the isIdentity() function which returns \c true if
the matrix is the identity matrix, and the isInvertible() function
- which returns true if the matrix is non-singular (i.e. AB = BA =
+ which returns \c true if the matrix is non-singular (i.e. AB = BA =
I). The inverted() function returns an inverted copy of \e this
matrix if it is invertible (otherwise it returns the identity
matrix), and adjoint() returns the matrix's classical adjoint.
@@ -763,8 +763,8 @@ QTransform & QTransform::rotateRadians(qreal a, Qt::Axis axis)
/*!
\fn bool QTransform::operator==(const QTransform &matrix) const
- Returns true if this matrix is equal to the given \a matrix,
- otherwise returns false.
+ Returns \c true if this matrix is equal to the given \a matrix,
+ otherwise returns \c false.
*/
bool QTransform::operator==(const QTransform &o) const
{
@@ -781,8 +781,8 @@ bool QTransform::operator==(const QTransform &o) const
/*!
\fn bool QTransform::operator!=(const QTransform &matrix) const
- Returns true if this matrix is not equal to the given \a matrix,
- otherwise returns false.
+ Returns \c true if this matrix is not equal to the given \a matrix,
+ otherwise returns \c false.
*/
bool QTransform::operator!=(const QTransform &o) const
{
@@ -1718,7 +1718,7 @@ QPolygon QTransform::mapToPolygon(const QRect &rect) const
/*!
Creates a transformation matrix, \a trans, that maps a unit square
- to a four-sided polygon, \a quad. Returns true if the transformation
+ to a four-sided polygon, \a quad. Returns \c true if the transformation
is constructed or false if such a transformation does not exist.
\sa quadToSquare(), quadToQuad()
@@ -1783,7 +1783,7 @@ bool QTransform::squareToQuad(const QPolygonF &quad, QTransform &trans)
\fn bool QTransform::quadToSquare(const QPolygonF &quad, QTransform &trans)
Creates a transformation matrix, \a trans, that maps a four-sided polygon,
- \a quad, to a unit square. Returns true if the transformation is constructed
+ \a quad, to a unit square. Returns \c true if the transformation is constructed
or false if such a transformation does not exist.
\sa squareToQuad(), quadToQuad()
@@ -1802,7 +1802,7 @@ bool QTransform::quadToSquare(const QPolygonF &quad, QTransform &trans)
/*!
Creates a transformation matrix, \a trans, that maps a four-sided
polygon, \a one, to another four-sided polygon, \a two.
- Returns true if the transformation is possible; otherwise returns
+ Returns \c true if the transformation is possible; otherwise returns
false.
This is a convenience method combining quadToSquare() and
@@ -2098,7 +2098,7 @@ QTransform::operator QVariant() const
/*!
\fn bool QTransform::isInvertible() const
- Returns true if the matrix is invertible, otherwise returns false.
+ Returns \c true if the matrix is invertible, otherwise returns \c false.
\sa inverted()
*/
@@ -2221,8 +2221,8 @@ QTransform::operator QVariant() const
/*!
\fn bool QTransform::isIdentity() const
- Returns true if the matrix is the identity matrix, otherwise
- returns false.
+ Returns \c true if the matrix is the identity matrix, otherwise
+ returns \c false.
\sa reset()
*/
@@ -2230,15 +2230,15 @@ QTransform::operator QVariant() const
/*!
\fn bool QTransform::isAffine() const
- Returns true if the matrix represent an affine transformation,
- otherwise returns false.
+ Returns \c true if the matrix represent an affine transformation,
+ otherwise returns \c false.
*/
/*!
\fn bool QTransform::isScaling() const
- Returns true if the matrix represents a scaling
- transformation, otherwise returns false.
+ Returns \c true if the matrix represents a scaling
+ transformation, otherwise returns \c false.
\sa reset()
*/
@@ -2246,8 +2246,8 @@ QTransform::operator QVariant() const
/*!
\fn bool QTransform::isRotating() const
- Returns true if the matrix represents some kind of a
- rotating transformation, otherwise returns false.
+ Returns \c true if the matrix represents some kind of a
+ rotating transformation, otherwise returns \c false.
\note A rotation transformation of 180 degrees and/or 360 degrees is treated as a scaling transformation.
@@ -2257,8 +2257,8 @@ QTransform::operator QVariant() const
/*!
\fn bool QTransform::isTranslating() const
- Returns true if the matrix represents a translating
- transformation, otherwise returns false.
+ Returns \c true if the matrix represents a translating
+ transformation, otherwise returns \c false.
\sa reset()
*/
@@ -2269,7 +2269,7 @@ QTransform::operator QVariant() const
\relates QTransform
\since 4.6
- Returns true if \a t1 and \a t2 are equal, allowing for a small
+ Returns \c true if \a t1 and \a t2 are equal, allowing for a small
fuzziness factor for floating-point comparisons; false otherwise.
*/