From 4533cc994484a2308297e64e99af005fb4dca065 Mon Sep 17 00:00:00 2001
From: Jerome Pasion <jerome.pasion@digia.com>
Date: Wed, 2 Oct 2013 16:51:05 +0200
Subject: 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>
---
 src/gui/painting/qpainter.cpp | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

(limited to 'src/gui/painting/qpainter.cpp')

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()
-- 
cgit v1.2.3