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>

16 files changed, 52 insertions, 52 deletions

diff --git a/src/tools/qdoc/codemarker.cpp b/src/tools/qdoc/codemarker.cpp
index a1f0068f7d..99f2abfb2f 100644
--- a/src/tools/qdoc/codemarker.cpp
+++ b/src/tools/qdoc/codemarker.cpp
@@ -459,7 +459,7 @@ void CodeMarker::insert(FastSection &fastSection,
 }
 
 /*!
-  Returns true if \a node represents a reimplemented member
+  Returns \c true if \a node represents a reimplemented member
   function in the class of the FastSection \a fs. If it is
   a reimplemented function, then it is inserted into the
   reimplemented member map in \a fs. The test is performed
diff --git a/src/tools/qdoc/codeparser.cpp b/src/tools/qdoc/codeparser.cpp
index 8f57a691bf..a0ea561b28 100644
--- a/src/tools/qdoc/codeparser.cpp
+++ b/src/tools/qdoc/codeparser.cpp
@@ -383,7 +383,7 @@ void CodeParser::setLink(Node* node, Node::LinkType linkType, const QString& arg
 }
 
 /*!
-  Returns true if the file being parsed is a .h file.
+  Returns \c true if the file being parsed is a .h file.
  */
 bool CodeParser::isParsingH() const
 {
@@ -391,7 +391,7 @@ bool CodeParser::isParsingH() const
 }
 
 /*!
-  Returns true if the file being parsed is a .cpp file.
+  Returns \c true if the file being parsed is a .cpp file.
  */
 bool CodeParser::isParsingCpp() const
 {
@@ -399,7 +399,7 @@ bool CodeParser::isParsingCpp() const
 }
 
 /*!
-  Returns true if the file being parsed is a .qdoc file.
+  Returns \c true if the file being parsed is a .qdoc file.
  */
 bool CodeParser::isParsingQdoc() const
 {
diff --git a/src/tools/qdoc/config.cpp b/src/tools/qdoc/config.cpp
index 0dd59fd214..cb9b8c3269 100644
--- a/src/tools/qdoc/config.cpp
+++ b/src/tools/qdoc/config.cpp
@@ -932,7 +932,7 @@ bool Config::removeDirContents(const QString& dir)
 }
 
 /*!
-  Returns true if \a ch is a letter, number, '_', '.',
+  Returns \c true if \a ch is a letter, number, '_', '.',
   '{', '}', or ','.
  */
 bool Config::isMetaKeyChar(QChar ch)
diff --git a/src/tools/qdoc/cppcodemarker.cpp b/src/tools/qdoc/cppcodemarker.cpp
index a5408f7178..24bd654238 100644
--- a/src/tools/qdoc/cppcodemarker.cpp
+++ b/src/tools/qdoc/cppcodemarker.cpp
@@ -70,7 +70,7 @@ CppCodeMarker::~CppCodeMarker()
 }
 
 /*!
-  Returns true.
+  Returns \c true.
  */
 bool CppCodeMarker::recognizeCode(const QString & /* code */)
 {
@@ -78,7 +78,7 @@ bool CppCodeMarker::recognizeCode(const QString & /* code */)
 }
 
 /*!
-  Returns true if \a ext is any of a list of file extensions
+  Returns \c true if \a ext is any of a list of file extensions
   for the C++ language.
  */
 bool CppCodeMarker::recognizeExtension(const QString& extension)
@@ -101,7 +101,7 @@ bool CppCodeMarker::recognizeExtension(const QString& extension)
 }
 
 /*!
-  Returns true if \a lang is either "C" or "Cpp".
+  Returns \c true if \a lang is either "C" or "Cpp".
  */
 bool CppCodeMarker::recognizeLanguage(const QString &lang)
 {
diff --git a/src/tools/qdoc/cppcodeparser.cpp b/src/tools/qdoc/cppcodeparser.cpp
index de9573e99d..cec042f92b 100644
--- a/src/tools/qdoc/cppcodeparser.cpp
+++ b/src/tools/qdoc/cppcodeparser.cpp
@@ -688,7 +688,7 @@ bool CppCodeParser::splitQmlPropertyGroupArg(const QString& arg,
   Components. A <QML-module> is the QML equivalent of a
   C++ namespace. So this function splits \a arg on "::"
   and stores the parts in \a type, \a module, \a qmlType,
-  and \a name, and returns true. If any part other than
+  and \a name, and returns \c true. If any part other than
   \a module is not found, a qdoc warning is emitted and
   false is returned.
 
diff --git a/src/tools/qdoc/ditaxmlgenerator.cpp b/src/tools/qdoc/ditaxmlgenerator.cpp
index ed92fc4722..095e3c9d30 100644
--- a/src/tools/qdoc/ditaxmlgenerator.cpp
+++ b/src/tools/qdoc/ditaxmlgenerator.cpp
@@ -5342,7 +5342,7 @@ DitaXmlGenerator::generateInnerNode(InnerNode* node)
 }
 
 /*!
-  Returns true if \a format is "DITAXML" or "HTML" .
+  Returns \c true if \a format is "DITAXML" or "HTML" .
  */
 bool DitaXmlGenerator::canHandleFormat(const QString& format)
 {
@@ -5751,7 +5751,7 @@ void DitaXmlGenerator::writeTopicrefs(NodeMultiMap* nmm, const QString& navtitle
   found value. Otherwise if \a force is set, an empty
   element is written using the tag.
 
-  Returns true or false depending on whether it writes
+  Returns \c true or false depending on whether it writes
   an element using the tag \a t.
 
   \note If \a t is found in the metadata map, it is erased.
@@ -5779,7 +5779,7 @@ bool DitaXmlGenerator::writeMetadataElement(const InnerNode* inner,
   value sfor the tag are found, the elements are written.
   Otherwise nothing is written.
 
-  Returns true or false depending on whether it writes
+  Returns \c true or false depending on whether it writes
   at least one element using the tag \a t.
 
   \note If \a t is found in the metadata map, it is erased.
diff --git a/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc
index 082d2b44e2..b41c450748 100644
--- a/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc
+++ b/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc
@@ -2908,7 +2908,7 @@
                The active window is the window that contains the widget that
                has keyboard focus.
 
-               When popup windows are visible, this property is true
+               When popup windows are visible, this property is \c true
                for both the active window \e and the popup.
 
                \sa activateWindow(), QApplication::activeWindow()
diff --git a/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc b/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc
index 3253a052a1..68f3f9652b 100644
--- a/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc
+++ b/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc
@@ -475,8 +475,8 @@
     / *!
         \fn bool QToolBar::isAreaAllowed(Qt::ToolBarArea area) const
 
-        Returns true if this toolbar is dockable in the given
-        \a area; otherwise returns false.
+        Returns \c true if this toolbar is dockable in the given
+        \a area; otherwise returns \c false.
     * /
     \endcode
 
@@ -488,8 +488,8 @@
            </h3>
         \endraw
 
-        Returns true if this toolbar is dockable in the given
-        \a area; otherwise returns false.
+        Returns \c true if this toolbar is dockable in the given
+        \a area; otherwise returns \c false.
     \endquotation
 
     See also \l {overload-command} {\\overload}.
@@ -1093,7 +1093,7 @@
     \code
     / *!
         \qmlattachedproperty bool ListView::isCurrentItem
-        This attached property is true if this delegate is the current
+        This attached property is \c true if this delegate is the current
     item; otherwise false.
 
         It is attached to each instance of the delegate.
diff --git a/src/tools/qdoc/jscodemarker.cpp b/src/tools/qdoc/jscodemarker.cpp
index 95b2866b03..c56dd8eb20 100644
--- a/src/tools/qdoc/jscodemarker.cpp
+++ b/src/tools/qdoc/jscodemarker.cpp
@@ -66,7 +66,7 @@ JsCodeMarker::~JsCodeMarker()
 }
 
 /*!
-  Returns true if the \a code is recognized by the parser.
+  Returns \c true if the \a code is recognized by the parser.
  */
 bool JsCodeMarker::recognizeCode(const QString &code)
 {
@@ -82,7 +82,7 @@ bool JsCodeMarker::recognizeCode(const QString &code)
 }
 
 /*!
-  Returns true if \a ext is any of a list of file extensions
+  Returns \c true if \a ext is any of a list of file extensions
   for the QML language.
  */
 bool JsCodeMarker::recognizeExtension(const QString &ext)
@@ -91,7 +91,7 @@ bool JsCodeMarker::recognizeExtension(const QString &ext)
 }
 
 /*!
-  Returns true if the \a language is recognized. We recognize JavaScript,
+  Returns \c true if the \a language is recognized. We recognize JavaScript,
   ECMAScript and JSON.
  */
 bool JsCodeMarker::recognizeLanguage(const QString &language)
diff --git a/src/tools/qdoc/location.cpp b/src/tools/qdoc/location.cpp
index 64a635115e..cdecb59626 100644
--- a/src/tools/qdoc/location.cpp
+++ b/src/tools/qdoc/location.cpp
@@ -204,7 +204,7 @@ void Location::pop()
 
 /*! \fn bool Location::isEmpty() const
 
-  Returns true if there is no file name set yet; returns false
+  Returns \c true if there is no file name set yet; returns \c false
   otherwise. The functions filePath(), lineNo() and columnNo()
   must not be called on an empty Location object.
  */
diff --git a/src/tools/qdoc/node.cpp b/src/tools/qdoc/node.cpp
index e854f101f6..75896e2718 100644
--- a/src/tools/qdoc/node.cpp
+++ b/src/tools/qdoc/node.cpp
@@ -625,7 +625,7 @@ ClassNode* Node::declarativeCppNode()
 }
 
 /*!
-  Returns true if the node's status is Internal, or if its
+  Returns \c true if the node's status is Internal, or if its
   parent is a class with internal status.
  */
 bool Node::isInternal() const
@@ -654,7 +654,7 @@ InnerNode::~InnerNode()
 }
 
 /*!
-  Returns true if this node's members coolection is not empty.
+  Returns \c true if this node's members coolection is not empty.
  */
 bool InnerNode::hasMembers() const
 {
@@ -672,7 +672,7 @@ void InnerNode::addMember(Node* node)
 }
 
 /*!
-  Returns true if this node's members collection contains at
+  Returns \c true if this node's members collection contains at
   least one namespace node.
  */
 bool InnerNode::hasNamespaces() const
@@ -689,7 +689,7 @@ bool InnerNode::hasNamespaces() const
 }
 
 /*!
-  Returns true if this node's members collection contains at
+  Returns \c true if this node's members collection contains at
   least one class node.
  */
 bool InnerNode::hasClasses() const
@@ -816,8 +816,8 @@ void InnerNode::findNodes(const QString& name, QList<Node*>& n)
   not a recearsive search.
 
   If \a qml is true, only match a node for which node->isQmlNode()
-  returns true. If \a qml is false, only match a node for which
-  node->isQmlNode() returns false.
+  returns \c true. If \a qml is false, only match a node for which
+  node->isQmlNode() returns \c false.
  */
 Node* InnerNode::findChildNodeByName(const QString& name, bool qml)
 {
@@ -1078,11 +1078,11 @@ void InnerNode::deleteChildren()
 }
 
 /*! \fn bool InnerNode::isInnerNode() const
-  Returns true because this is an inner node.
+  Returns \c true because this is an inner node.
  */
 
 /*!
-  Returns true if the node is a class node or a QML type node
+  Returns \c true if the node is a class node or a QML type node
   that is marked as being a wrapper class or QML type, or if
   it is a member of a wrapper class or type.
  */
@@ -1101,8 +1101,8 @@ const Node *InnerNode::findChildNodeByName(const QString& name) const
 
 /*!
   If \a qml is true, only match a node for which node->isQmlNode()
-  returns true. If \a qml is false, only match a node for which
-  node->isQmlNode() returns false.
+  returns \c true. If \a qml is false, only match a node for which
+  node->isQmlNode() returns \c false.
  */
 const Node* InnerNode::findChildNodeByName(const QString& name, bool qml) const
 {
@@ -1395,7 +1395,7 @@ QmlPropertyNode* InnerNode::hasQmlProperty(const QString& n) const
  */
 
 /*! \fn bool LeafNode::isInnerNode() const
-  Returns false because this is a LeafNode.
+  Returns \c false because this is a LeafNode.
  */
 
 /*!
@@ -2329,7 +2329,7 @@ QmlPropertyNode::QmlPropertyNode(InnerNode* parent,
 }
 
 /*!
-  Returns true if a QML property or attached property is
+  Returns \c true if a QML property or attached property is
   not read-only. The algorithm for figuring this out is long
   amd tedious and almost certainly will break. It currently
   doesn't work for the qmlproperty:
@@ -2474,7 +2474,7 @@ NameCollisionNode::~NameCollisionNode()
  */
 
 /*!
-  Returns true if this collision node's current node is a QML node.
+  Returns \c true if this collision node's current node is a QML node.
  */
 bool NameCollisionNode::isQmlNode() const
 {
diff --git a/src/tools/qdoc/qdocindexfiles.cpp b/src/tools/qdoc/qdocindexfiles.cpp
index 4181478274..7424971b13 100644
--- a/src/tools/qdoc/qdocindexfiles.cpp
+++ b/src/tools/qdoc/qdocindexfiles.cpp
@@ -1162,7 +1162,7 @@ bool QDocIndexFiles::generateIndexSection(QXmlStreamWriter& writer,
 }
 
 /*!
-  Returns true if the node \a n1 is less than node \a n2. The
+  Returns \c true if the node \a n1 is less than node \a n2. The
   comparison is performed by comparing properties of the nodes
   in order of increasing complexity.
 */
diff --git a/src/tools/qdoc/qmlcodemarker.cpp b/src/tools/qdoc/qmlcodemarker.cpp
index 35c0953d9f..5e4e1d4b40 100644
--- a/src/tools/qdoc/qmlcodemarker.cpp
+++ b/src/tools/qdoc/qmlcodemarker.cpp
@@ -67,7 +67,7 @@ QmlCodeMarker::~QmlCodeMarker()
 }
 
 /*!
-  Returns true if the \a code is recognized by the parser.
+  Returns \c true if the \a code is recognized by the parser.
  */
 bool QmlCodeMarker::recognizeCode(const QString &code)
 {
@@ -83,7 +83,7 @@ bool QmlCodeMarker::recognizeCode(const QString &code)
 }
 
 /*!
-  Returns true if \a ext is any of a list of file extensions
+  Returns \c true if \a ext is any of a list of file extensions
   for the QML language.
  */
 bool QmlCodeMarker::recognizeExtension(const QString &ext)
@@ -92,7 +92,7 @@ bool QmlCodeMarker::recognizeExtension(const QString &ext)
 }
 
 /*!
-  Returns true if the \a language is recognized. Only "QML" is
+  Returns \c true if the \a language is recognized. Only "QML" is
   recognized by this marker.
  */
 bool QmlCodeMarker::recognizeLanguage(const QString &language)
diff --git a/src/tools/qdoc/qmlvisitor.cpp b/src/tools/qdoc/qmlvisitor.cpp
index c049857717..323c312eb5 100644
--- a/src/tools/qdoc/qmlvisitor.cpp
+++ b/src/tools/qdoc/qmlvisitor.cpp
@@ -311,7 +311,7 @@ bool QmlDocVisitor::applyDocumentation(QQmlJS::AST::SourceLocation location, Nod
   C++ namespace. So this function splits \a arg on "::"
   and stores the parts in the \e {type}, \e {module},
   \e {component}, and \a {name}, fields of \a qpa. If it
-  is successful, it returns true. If not enough parts
+  is successful, it returns \c true. If not enough parts
   are found, a qdoc warning is emitted and false is
   returned.
  */
diff --git a/src/tools/qdoc/tokenizer.cpp b/src/tools/qdoc/tokenizer.cpp
index e1ca28eef8..dc934a6473 100644
--- a/src/tools/qdoc/tokenizer.cpp
+++ b/src/tools/qdoc/tokenizer.cpp
@@ -715,7 +715,7 @@ bool Tokenizer::popSkipping()
 }
 
 /*
-  Returns true if the condition evaluates as true, otherwise false.  The
+  Returns \c true if the condition evaluates as true, otherwise false.  The
   condition is represented by a string.  Unsophisticated parsing techniques are
   used.  The preprocessing method could be named StriNg-Oriented PreProcessing,
   as SNOBOL stands for StriNg-Oriented symBOlic Language.
diff --git a/src/tools/qdoc/yyindent.cpp b/src/tools/qdoc/yyindent.cpp
index 08ac0dfe3b..9d7a66a55a 100644
--- a/src/tools/qdoc/yyindent.cpp
+++ b/src/tools/qdoc/yyindent.cpp
@@ -148,8 +148,8 @@ static QChar firstNonWhiteSpace( const QString& t )
 }
 
 /*
-    Returns true if string t is made only of white space; otherwise
-    returns false.
+    Returns \c true if string t is made only of white space; otherwise
+    returns \c false.
 */
 static bool isOnlyWhiteSpace( const QString& t )
 {
@@ -283,8 +283,8 @@ static inline QChar lastParen( const QString& t )
 }
 
 /*
-    Returns true if typedIn the same as okayCh or is null; otherwise
-    returns false.
+    Returns \c true if typedIn the same as okayCh or is null; otherwise
+    returns \c false.
 */
 static inline bool okay( QChar typedIn, QChar okayCh )
 {
@@ -456,9 +456,9 @@ static void startLinizer()
 }
 
 /*
-    Returns true if the start of the bottom line of yyProgram (and
+    Returns \c true if the start of the bottom line of yyProgram (and
     potentially the whole line) is part of a C-style comment;
-    otherwise returns false.
+    otherwise returns \c false.
 */
 static bool bottomLineStartsInCComment()
 {
@@ -526,15 +526,15 @@ static int indentWhenBottomLineStartsInCComment()
 
 /*
     A function called match...() modifies the linizer state. If it
-    returns true, yyLine is the top line of the matched construct;
+    returns \c true, yyLine is the top line of the matched construct;
     otherwise, the linizer is left in an unknown state.
 
     A function called is...() keeps the linizer state intact.
 */
 
 /*
-    Returns true if the current line (and upwards) forms a braceless
-    control statement; otherwise returns false.
+    Returns \c true if the current line (and upwards) forms a braceless
+    control statement; otherwise returns \c false.
 
     The first line of the following example is a "braceless control
     statement":
@@ -614,7 +614,7 @@ static bool matchBracelessControlStatement()
 }
 
 /*
-    Returns true if yyLine is an unfinished line; otherwise returns
+    Returns \c true if yyLine is an unfinished line; otherwise returns
     false.
 
     In many places we'll use the terms "standalone line", "unfinished
@@ -669,7 +669,7 @@ static bool isUnfinishedLine()
 }
 
 /*
-    Returns true if yyLine is a continuation line; otherwise returns
+    Returns \c true if yyLine is a continuation line; otherwise returns
     false.
 */
 static bool isContinuationLine()