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/corelib/json/qjsondocument.cpp |  8 ++++----
 src/corelib/json/qjsonvalue.cpp    | 18 +++++++++---------
 2 files changed, 13 insertions(+), 13 deletions(-)

(limited to 'src/corelib/json')

diff --git a/src/corelib/json/qjsondocument.cpp b/src/corelib/json/qjsondocument.cpp
index 05d57e2ab9..4806ac68d6 100644
--- a/src/corelib/json/qjsondocument.cpp
+++ b/src/corelib/json/qjsondocument.cpp
@@ -372,7 +372,7 @@ QJsonDocument QJsonDocument::fromJson(const QByteArray &json, QJsonParseError *e
 }
 
 /*!
-    Returns true if the document doesn't contain any data.
+    Returns \c true if the document doesn't contain any data.
  */
 bool QJsonDocument::isEmpty() const
 {
@@ -403,7 +403,7 @@ QByteArray QJsonDocument::toBinaryData() const
 }
 
 /*!
-    Returns true if the document contains an array.
+    Returns \c true if the document contains an array.
 
     \sa array(), isObject()
  */
@@ -417,7 +417,7 @@ bool QJsonDocument::isArray() const
 }
 
 /*!
-    Returns true if the document contains an object.
+    Returns \c true if the document contains an object.
 
     \sa object(), isArray()
  */
@@ -549,7 +549,7 @@ bool QJsonDocument::operator==(const QJsonDocument &other) const
  */
 
 /*!
-    returns true if this document is null.
+    returns \c true if this document is null.
 
     Null documents are documents created through the default constructor.
 
diff --git a/src/corelib/json/qjsonvalue.cpp b/src/corelib/json/qjsonvalue.cpp
index d0634602f3..8aa1f654c6 100644
--- a/src/corelib/json/qjsonvalue.cpp
+++ b/src/corelib/json/qjsonvalue.cpp
@@ -271,13 +271,13 @@ QJsonValue &QJsonValue::operator =(const QJsonValue &other)
 /*!
     \fn bool QJsonValue::isNull() const
 
-    Returns true if the value is null.
+    Returns \c true if the value is null.
 */
 
 /*!
     \fn bool QJsonValue::isBool() const
 
-    Returns true if the value contains a boolean.
+    Returns \c true if the value contains a boolean.
 
     \sa toBool()
  */
@@ -285,7 +285,7 @@ QJsonValue &QJsonValue::operator =(const QJsonValue &other)
 /*!
     \fn bool QJsonValue::isDouble() const
 
-    Returns true if the value contains a double.
+    Returns \c true if the value contains a double.
 
     \sa toDouble()
  */
@@ -293,7 +293,7 @@ QJsonValue &QJsonValue::operator =(const QJsonValue &other)
 /*!
     \fn bool QJsonValue::isString() const
 
-    Returns true if the value contains a string.
+    Returns \c true if the value contains a string.
 
     \sa toString()
  */
@@ -301,7 +301,7 @@ QJsonValue &QJsonValue::operator =(const QJsonValue &other)
 /*!
     \fn bool QJsonValue::isArray() const
 
-    Returns true if the value contains an array.
+    Returns \c true if the value contains an array.
 
     \sa toArray()
  */
@@ -309,7 +309,7 @@ QJsonValue &QJsonValue::operator =(const QJsonValue &other)
 /*!
     \fn bool QJsonValue::isObject() const
 
-    Returns true if the value contains an object.
+    Returns \c true if the value contains an object.
 
     \sa toObject()
  */
@@ -317,7 +317,7 @@ QJsonValue &QJsonValue::operator =(const QJsonValue &other)
 /*!
     \fn bool QJsonValue::isUndefined() const
 
-    Returns true if the value is undefined. This can happen in certain
+    Returns \c true if the value is undefined. This can happen in certain
     error cases as e.g. accessing a non existing key in a QJsonObject.
  */
 
@@ -540,7 +540,7 @@ QJsonObject QJsonValue::toObject() const
 }
 
 /*!
-    Returns true if the value is equal to \a other.
+    Returns \c true if the value is equal to \a other.
  */
 bool QJsonValue::operator==(const QJsonValue &other) const
 {
@@ -576,7 +576,7 @@ bool QJsonValue::operator==(const QJsonValue &other) const
 }
 
 /*!
-    Returns true if the value is not equal to \a other.
+    Returns \c true if the value is not equal to \a other.
  */
 bool QJsonValue::operator!=(const QJsonValue &other) const
 {
-- 
cgit v1.2.3