summaryrefslogtreecommitdiffstats
path: root/src/xml
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/xml
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/xml')
-rw-r--r--src/xml/dom/qdom.cpp146
-rw-r--r--src/xml/sax/qxml.cpp94
2 files changed, 120 insertions, 120 deletions
diff --git a/src/xml/dom/qdom.cpp b/src/xml/dom/qdom.cpp
index c37172a187..2383bda1c9 100644
--- a/src/xml/dom/qdom.cpp
+++ b/src/xml/dom/qdom.cpp
@@ -938,8 +938,8 @@ QDomImplementation& QDomImplementation::operator=(const QDomImplementation &x)
}
/*!
- Returns true if \a x and this DOM implementation object were
- created from the same QDomDocument; otherwise returns false.
+ Returns \c true if \a x and this DOM implementation object were
+ created from the same QDomDocument; otherwise returns \c false.
*/
bool QDomImplementation::operator==(const QDomImplementation &x) const
{
@@ -947,8 +947,8 @@ bool QDomImplementation::operator==(const QDomImplementation &x) const
}
/*!
- Returns true if \a x and this DOM implementation object were
- created from different QDomDocuments; otherwise returns false.
+ Returns \c true if \a x and this DOM implementation object were
+ created from different QDomDocuments; otherwise returns \c false.
*/
bool QDomImplementation::operator!=(const QDomImplementation &x) const
{
@@ -965,8 +965,8 @@ QDomImplementation::~QDomImplementation()
}
/*!
- The function returns true if QDom implements the requested \a
- version of a \a feature; otherwise returns false.
+ The function returns \c true if QDom implements the requested \a
+ version of a \a feature; otherwise returns \c false.
The currently supported features and their versions:
\table
@@ -1061,8 +1061,8 @@ QDomDocument QDomImplementation::createDocument(const QString& nsURI, const QStr
}
/*!
- Returns false if the object was created by
- QDomDocument::implementation(); otherwise returns true.
+ Returns \c false if the object was created by
+ QDomDocument::implementation(); otherwise returns \c true.
*/
bool QDomImplementation::isNull()
{
@@ -1334,8 +1334,8 @@ QDomNodeList& QDomNodeList::operator=(const QDomNodeList &n)
}
/*!
- Returns true if the node list \a n and this node list are equal;
- otherwise returns false.
+ Returns \c true if the node list \a n and this node list are equal;
+ otherwise returns \c false.
*/
bool QDomNodeList::operator==(const QDomNodeList &n) const
{
@@ -1347,8 +1347,8 @@ bool QDomNodeList::operator==(const QDomNodeList &n) const
}
/*!
- Returns true the node list \a n and this node list are not equal;
- otherwise returns false.
+ Returns \c true the node list \a n and this node list are not equal;
+ otherwise returns \c false.
*/
bool QDomNodeList::operator!=(const QDomNodeList &n) const
{
@@ -1394,7 +1394,7 @@ int QDomNodeList::length() const
/*!
\fn bool QDomNodeList::isEmpty() const
- Returns true if the list contains no items; otherwise returns false.
+ Returns \c true if the list contains no items; otherwise returns \c false.
This function is provided for Qt API consistency.
*/
@@ -2051,8 +2051,8 @@ QDomNode& QDomNode::operator=(const QDomNode &n)
}
/*!
- Returns true if \a n and this DOM node are equal; otherwise
- returns false.
+ Returns \c true if \a n and this DOM node are equal; otherwise
+ returns \c false.
Any instance of QDomNode acts as a reference to an underlying data
structure in QDomDocument. The test for equality checks if the two
@@ -2076,8 +2076,8 @@ bool QDomNode::operator== (const QDomNode& n) const
}
/*!
- Returns true if \a n and this DOM node are not equal; otherwise
- returns false.
+ Returns \c true if \a n and this DOM node are not equal; otherwise
+ returns \c false.
*/
bool QDomNode::operator!= (const QDomNode& n) const
{
@@ -2206,7 +2206,7 @@ QDomNode::NodeType QDomNode::nodeType() const
/*!
Returns the parent node. If this node has no parent, a null node
- is returned (i.e. a node for which isNull() returns true).
+ is returned (i.e. a node for which isNull() returns \c true).
*/
QDomNode QDomNode::parentNode() const
{
@@ -2364,9 +2364,9 @@ void QDomNode::normalize()
}
/*!
- Returns true if the DOM implementation implements the feature \a
+ Returns \c true if the DOM implementation implements the feature \a
feature and this feature is supported by this node in the version
- \a version; otherwise returns false.
+ \a version; otherwise returns \c false.
\sa QDomImplementation::hasFeature()
*/
@@ -2466,7 +2466,7 @@ QString QDomNode::localName() const
}
/*!
- Returns true if the node has attributes; otherwise returns false.
+ Returns \c true if the node has attributes; otherwise returns \c false.
\sa attributes()
*/
@@ -2608,8 +2608,8 @@ QDomNode QDomNode::appendChild(const QDomNode& newChild)
}
/*!
- Returns true if the node has one or more children; otherwise
- returns false.
+ Returns \c true if the node has one or more children; otherwise
+ returns \c false.
*/
bool QDomNode::hasChildNodes() const
{
@@ -2619,8 +2619,8 @@ bool QDomNode::hasChildNodes() const
}
/*!
- Returns true if this node is null (i.e. if it has no type or
- contents); otherwise returns false.
+ Returns \c true if this node is null (i.e. if it has no type or
+ contents); otherwise returns \c false.
*/
bool QDomNode::isNull() const
{
@@ -2706,9 +2706,9 @@ QTextStream& operator<<(QTextStream& str, const QDomNode& node)
}
/*!
- Returns true if the node is an attribute; otherwise returns false.
+ Returns \c true if the node is an attribute; otherwise returns \c false.
- If this function returns true, it does not imply that this object
+ If this function returns \c true, it does not imply that this object
is a QDomAttribute; you can get the QDomAttribute with
toAttribute().
@@ -2722,10 +2722,10 @@ bool QDomNode::isAttr() const
}
/*!
- Returns true if the node is a CDATA section; otherwise returns
+ Returns \c true if the node is a CDATA section; otherwise returns
false.
- If this function returns true, it does not imply that this object
+ If this function returns \c true, it does not imply that this object
is a QDomCDATASection; you can get the QDomCDATASection with
toCDATASection().
@@ -2739,10 +2739,10 @@ bool QDomNode::isCDATASection() const
}
/*!
- Returns true if the node is a document fragment; otherwise returns
+ Returns \c true if the node is a document fragment; otherwise returns
false.
- If this function returns true, it does not imply that this object
+ If this function returns \c true, it does not imply that this object
is a QDomDocumentFragment; you can get the QDomDocumentFragment
with toDocumentFragment().
@@ -2756,9 +2756,9 @@ bool QDomNode::isDocumentFragment() const
}
/*!
- Returns true if the node is a document; otherwise returns false.
+ Returns \c true if the node is a document; otherwise returns \c false.
- If this function returns true, it does not imply that this object
+ If this function returns \c true, it does not imply that this object
is a QDomDocument; you can get the QDomDocument with toDocument().
\sa toDocument()
@@ -2771,10 +2771,10 @@ bool QDomNode::isDocument() const
}
/*!
- Returns true if the node is a document type; otherwise returns
+ Returns \c true if the node is a document type; otherwise returns
false.
- If this function returns true, it does not imply that this object
+ If this function returns \c true, it does not imply that this object
is a QDomDocumentType; you can get the QDomDocumentType with
toDocumentType().
@@ -2788,9 +2788,9 @@ bool QDomNode::isDocumentType() const
}
/*!
- Returns true if the node is an element; otherwise returns false.
+ Returns \c true if the node is an element; otherwise returns \c false.
- If this function returns true, it does not imply that this object
+ If this function returns \c true, it does not imply that this object
is a QDomElement; you can get the QDomElement with toElement().
\sa toElement()
@@ -2803,10 +2803,10 @@ bool QDomNode::isElement() const
}
/*!
- Returns true if the node is an entity reference; otherwise returns
+ Returns \c true if the node is an entity reference; otherwise returns
false.
- If this function returns true, it does not imply that this object
+ If this function returns \c true, it does not imply that this object
is a QDomEntityReference; you can get the QDomEntityReference with
toEntityReference().
@@ -2820,9 +2820,9 @@ bool QDomNode::isEntityReference() const
}
/*!
- Returns true if the node is a text node; otherwise returns false.
+ Returns \c true if the node is a text node; otherwise returns \c false.
- If this function returns true, it does not imply that this object
+ If this function returns \c true, it does not imply that this object
is a QDomText; you can get the QDomText with toText().
\sa toText()
@@ -2835,9 +2835,9 @@ bool QDomNode::isText() const
}
/*!
- Returns true if the node is an entity; otherwise returns false.
+ Returns \c true if the node is an entity; otherwise returns \c false.
- If this function returns true, it does not imply that this object
+ If this function returns \c true, it does not imply that this object
is a QDomEntity; you can get the QDomEntity with toEntity().
\sa toEntity()
@@ -2850,9 +2850,9 @@ bool QDomNode::isEntity() const
}
/*!
- Returns true if the node is a notation; otherwise returns false.
+ Returns \c true if the node is a notation; otherwise returns \c false.
- If this function returns true, it does not imply that this object
+ If this function returns \c true, it does not imply that this object
is a QDomNotation; you can get the QDomNotation with toNotation().
\sa toNotation()
@@ -2865,10 +2865,10 @@ bool QDomNode::isNotation() const
}
/*!
- Returns true if the node is a processing instruction; otherwise
- returns false.
+ Returns \c true if the node is a processing instruction; otherwise
+ returns \c false.
- If this function returns true, it does not imply that this object
+ If this function returns \c true, it does not imply that this object
is a QDomProcessingInstruction; you can get the
QProcessingInstruction with toProcessingInstruction().
@@ -2882,10 +2882,10 @@ bool QDomNode::isProcessingInstruction() const
}
/*!
- Returns true if the node is a character data node; otherwise
- returns false.
+ Returns \c true if the node is a character data node; otherwise
+ returns \c false.
- If this function returns true, it does not imply that this object
+ If this function returns \c true, it does not imply that this object
is a QDomCharacterData; you can get the QDomCharacterData with
toCharacterData().
@@ -2899,9 +2899,9 @@ bool QDomNode::isCharacterData() const
}
/*!
- Returns true if the node is a comment; otherwise returns false.
+ Returns \c true if the node is a comment; otherwise returns \c false.
- If this function returns true, it does not imply that this object
+ If this function returns \c true, it does not imply that this object
is a QDomComment; you can get the QDomComment with toComment().
\sa toComment()
@@ -3253,8 +3253,8 @@ QDomNamedNodeMap& QDomNamedNodeMap::operator=(const QDomNamedNodeMap &n)
}
/*!
- Returns true if \a n and this named node map are equal; otherwise
- returns false.
+ Returns \c true if \a n and this named node map are equal; otherwise
+ returns \c false.
*/
bool QDomNamedNodeMap::operator== (const QDomNamedNodeMap& n) const
{
@@ -3262,8 +3262,8 @@ bool QDomNamedNodeMap::operator== (const QDomNamedNodeMap& n) const
}
/*!
- Returns true if \a n and this named node map are not equal;
- otherwise returns false.
+ Returns \c true if \a n and this named node map are not equal;
+ otherwise returns \c false.
*/
bool QDomNamedNodeMap::operator!= (const QDomNamedNodeMap& n) const
{
@@ -3410,7 +3410,7 @@ int QDomNamedNodeMap::length() const
/*!
\fn bool QDomNamedNodeMap::isEmpty() const
- Returns true if the map is empty; otherwise returns false. This function is
+ Returns \c true if the map is empty; otherwise returns \c false. This function is
provided for Qt API consistency.
*/
@@ -3427,8 +3427,8 @@ int QDomNamedNodeMap::length() const
*/
/*!
- Returns true if the map contains a node called \a name; otherwise
- returns false.
+ Returns \c true if the map contains a node called \a name; otherwise
+ returns \c false.
\b{Note:} This function does not take the presence of namespaces into account.
Use namedItemNS() to test whether the map contains a node with a specific namespace
@@ -4324,8 +4324,8 @@ QString QDomAttr::name() const
}
/*!
- Returns true if the attribute has been set by the user with setValue().
- Returns false if the value hasn't been specified or set.
+ Returns \c true if the attribute has been set by the user with setValue().
+ Returns \c false if the value hasn't been specified or set.
\sa setValue()
*/
@@ -4955,8 +4955,8 @@ QDomNodeList QDomElement::elementsByTagName(const QString& tagname) const
}
/*!
- Returns true if this element has an attribute called \a name;
- otherwise returns false.
+ Returns \c true if this element has an attribute called \a name;
+ otherwise returns \c false.
\b{Note:} This function does not take the presence of namespaces
into account. As a result, the specified name will be tested
@@ -5117,7 +5117,7 @@ QDomNodeList QDomElement::elementsByTagNameNS(const QString& nsURI, const QStrin
}
/*!
- Returns true if this element has an attribute with the local name
+ Returns \c true if this element has an attribute with the local name
\a localName and the namespace URI \a nsURI; otherwise returns
false.
*/
@@ -6652,7 +6652,7 @@ QDomDocument::~QDomDocument()
\overload
This function reads the XML document from the string \a text, returning
- true if the content was successfully parsed; otherwise returns false.
+ true if the content was successfully parsed; otherwise returns \c false.
Since \a text is already a Unicode string, no encoding detection
is done.
*/
@@ -6679,11 +6679,11 @@ bool QDomDocument::setContent(const QString& text, bool namespaceProcessing, QSt
is false, the parser does no namespace processing when it reads
the XML file.
- If a parse error occurs, this function returns false and the error
+ If a parse error occurs, this function returns \c false and the error
message is placed in \c{*}\a{errorMsg}, the line number in
\c{*}\a{errorLine} and the column number in \c{*}\a{errorColumn}
(unless the associated pointer is set to 0); otherwise this
- function returns true. The various error messages are described in
+ function returns \c true. The various error messages are described in
the QXmlParseException class documentation. Note that, if you
want to display these error messages to your application's users,
they will be displayed in English unless they are explicitly
@@ -6734,7 +6734,7 @@ bool QDomDocument::setContent(const QByteArray &data, bool namespaceProcessing,
\overload
This function reads the XML document from the IO device \a dev, returning
- true if the content was successfully parsed; otherwise returns false.
+ true if the content was successfully parsed; otherwise returns \c false.
*/
bool QDomDocument::setContent(QIODevice* dev, bool namespaceProcessing, QString *errorMsg, int *errorLine, int *errorColumn)
{
@@ -6749,7 +6749,7 @@ bool QDomDocument::setContent(QIODevice* dev, bool namespaceProcessing, QString
\since 4.5
This function reads the XML document from the QXmlInputSource \a source,
- returning true if the content was successfully parsed; otherwise returns false.
+ returning true if the content was successfully parsed; otherwise returns \c false.
*/
bool QDomDocument::setContent(QXmlInputSource *source, bool namespaceProcessing, QString *errorMsg, int *errorLine, int *errorColumn )
@@ -6765,7 +6765,7 @@ bool QDomDocument::setContent(QXmlInputSource *source, bool namespaceProcessing,
\overload
This function reads the XML document from the string \a text, returning
- true if the content was successfully parsed; otherwise returns false.
+ true if the content was successfully parsed; otherwise returns \c false.
Since \a text is already a Unicode string, no encoding detection
is performed.
@@ -6794,7 +6794,7 @@ bool QDomDocument::setContent(const QByteArray& buffer, QString *errorMsg, int *
\overload
This function reads the XML document from the IO device \a dev, returning
- true if the content was successfully parsed; otherwise returns false.
+ true if the content was successfully parsed; otherwise returns \c false.
No namespace processing is performed.
*/
@@ -6808,7 +6808,7 @@ bool QDomDocument::setContent(QIODevice* dev, QString *errorMsg, int *errorLine,
This function reads the XML document from the QXmlInputSource \a source and
parses it with the QXmlReader \a reader, returning true if the content was
- successfully parsed; otherwise returns false.
+ successfully parsed; otherwise returns \c false.
This function doesn't change the features of the \a reader. If you want to
use certain features for parsing you can use this function to set up the
diff --git a/src/xml/sax/qxml.cpp b/src/xml/sax/qxml.cpp
index 0e20041a62..45c0f3e17b 100644
--- a/src/xml/sax/qxml.cpp
+++ b/src/xml/sax/qxml.cpp
@@ -180,7 +180,7 @@ static const signed char charLookupTable[256]={
/*
This function strips the TextDecl [77] ("<?xml ...?>") from the string \a
str. The stripped version is stored in \a str. If this function finds an
- invalid TextDecl, it returns false, otherwise true.
+ invalid TextDecl, it returns \c false, otherwise true.
This function is used for external entities since those can include an
TextDecl that must be stripped before inserting the entity.
@@ -1734,7 +1734,7 @@ QString QXmlInputSource::fromRawData(const QByteArray &data, bool beginning)
to setDocumentLocator(), and before any other functions in this
class or in the QXmlDTDHandler class are called.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
@@ -1749,7 +1749,7 @@ QString QXmlInputSource::fromRawData(const QByteArray &data, bool beginning)
is called after the reader has read all input or has abandoned
parsing because of a fatal error.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
@@ -1774,7 +1774,7 @@ QString QXmlInputSource::fromRawData(const QByteArray &data, bool beginning)
The argument \a prefix is the namespace prefix being declared and
the argument \a uri is the namespace URI the prefix is mapped to.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
@@ -1787,7 +1787,7 @@ QString QXmlInputSource::fromRawData(const QByteArray &data, bool beginning)
The reader calls this function to signal the end of a prefix
mapping for the prefix \a prefix.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
@@ -1819,7 +1819,7 @@ QString QXmlInputSource::fromRawData(const QByteArray &data, bool beginning)
the attributes attached to the element. If there are no
attributes, \a atts is an empty attributes object.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
@@ -1833,7 +1833,7 @@ QString QXmlInputSource::fromRawData(const QByteArray &data, bool beginning)
tag with the qualified name \a qName, the local name \a localName
and the namespace URI \a namespaceURI.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
@@ -1857,7 +1857,7 @@ QString QXmlInputSource::fromRawData(const QByteArray &data, bool beginning)
one chunk; e.g. a reader might want to report "a\<b" in three
characters() events ("a ", "\<" and " b").
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
*/
@@ -1868,7 +1868,7 @@ QString QXmlInputSource::fromRawData(const QByteArray &data, bool beginning)
Some readers may use this function to report each chunk of
whitespace in element content. The whitespace is reported in \a ch.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
*/
@@ -1882,7 +1882,7 @@ QString QXmlInputSource::fromRawData(const QByteArray &data, bool beginning)
\a target is the target name of the processing instruction and \a
data is the data in the processing instruction.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
*/
@@ -1895,7 +1895,7 @@ QString QXmlInputSource::fromRawData(const QByteArray &data, bool beginning)
do so they report that they skipped the entity called \a name by
calling this function.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
*/
@@ -1904,7 +1904,7 @@ QString QXmlInputSource::fromRawData(const QByteArray &data, bool beginning)
\fn QString QXmlContentHandler::errorString() const
The reader calls this function to get an error string, e.g. if any
- of the handler functions returns false.
+ of the handler functions returns \c false.
*/
@@ -1943,7 +1943,7 @@ QString QXmlInputSource::fromRawData(const QByteArray &data, bool beginning)
XML 1.0 specification. Details of the warning are stored in \a
exception.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
*/
@@ -1959,7 +1959,7 @@ QString QXmlInputSource::fromRawData(const QByteArray &data, bool beginning)
The reader must continue to provide normal parsing events after
invoking this function.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
*/
@@ -1970,7 +1970,7 @@ QString QXmlInputSource::fromRawData(const QByteArray &data, bool beginning)
A reader must use this function to report a non-recoverable error.
Details of the error are stored in \a exception.
-If this function returns true the reader might try to go on
+If this function returns \c true the reader might try to go on
parsing and reporting further errors, but no regular parsing
events are reported.
*/
@@ -1979,7 +1979,7 @@ events are reported.
\fn QString QXmlErrorHandler::errorString() const
The reader calls this function to get an error string if any of
- the handler functions returns false.
+ the handler functions returns \c false.
*/
@@ -2021,7 +2021,7 @@ events are reported.
notation's public identifier and \a systemId is the notation's
system identifier.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
*/
@@ -2037,7 +2037,7 @@ events are reported.
identifier and \a notationName is the name of the associated
notation.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
*/
@@ -2046,7 +2046,7 @@ events are reported.
\fn QString QXmlDTDHandler::errorString() const
The reader calls this function to get an error string if any of
- the handler functions returns false.
+ the handler functions returns \c false.
*/
@@ -2093,7 +2093,7 @@ events are reported.
non-zero it must point to an input source which the reader uses
instead.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
*/
@@ -2102,7 +2102,7 @@ events are reported.
\fn QString QXmlEntityResolver::errorString() const
The reader calls this function to get an error string if any of
- the handler functions returns false.
+ the handler functions returns \c false.
*/
@@ -2156,7 +2156,7 @@ events are reported.
All declarations reported through QXmlDTDHandler or
QXmlDeclHandler appear between the startDTD() and endDTD() calls.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
@@ -2169,7 +2169,7 @@ events are reported.
The reader calls this function to report the end of a DTD
declaration, if any.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
@@ -2186,7 +2186,7 @@ events are reported.
QXmlContentHandler::skippedEntity() and not through this
function.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
@@ -2203,7 +2203,7 @@ events are reported.
call. The calls to startEntity() and endEntity() are properly
nested.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
@@ -2218,7 +2218,7 @@ events are reported.
QXmlContentHandler::characters() function. This function is
intended only to report the boundary.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
@@ -2231,7 +2231,7 @@ events are reported.
The reader calls this function to report the end of a CDATA
section.
- If this function returns false the reader stops parsing and reports
+ If this function returns \c false the reader stops parsing and reports
an error. The reader uses the function errorString() to get the error
message.
@@ -2244,7 +2244,7 @@ events are reported.
The reader calls this function to report an XML comment anywhere
in the document. It reports the text of the comment in \a ch.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
*/
@@ -2253,7 +2253,7 @@ events are reported.
\fn QString QXmlLexicalHandler::errorString() const
The reader calls this function to get an error string if any of
- the handler functions returns false.
+ the handler functions returns \c false.
*/
@@ -2300,7 +2300,7 @@ events are reported.
default value in \a value. If no default value is specified in the
XML file, \a value is an empty string.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
*/
@@ -2314,7 +2314,7 @@ events are reported.
The reader passes the name of the entity in \a name and the value
of the entity in \a value.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
*/
@@ -2331,7 +2331,7 @@ events are reported.
systemId. If there is no public identifier specified, it passes
an empty string in \a publicId.
- If this function returns false the reader stops parsing and
+ If this function returns \c false the reader stops parsing and
reports an error. The reader uses the function errorString() to
get the error message.
*/
@@ -2340,7 +2340,7 @@ events are reported.
\fn QString QXmlDeclHandler::errorString() const
The reader calls this function to get an error string if any of
- the handler functions returns false.
+ the handler functions returns \c false.
*/
@@ -2383,7 +2383,7 @@ events are reported.
\snippet rsslisting/handler.cpp 0
- The above function returns false, which tells the reader to stop
+ The above function returns \c false, which tells the reader to stop
parsing. To continue to use the same reader,
it is necessary to create a new handler instance, and set up the
reader to use it in the manner described above.
@@ -2854,7 +2854,7 @@ void QXmlSimpleReaderPrivate::initIncrementalParsing()
\fn bool QXmlReader::hasFeature(const QString& name) const
Returns \c true if the reader has the feature called \a name;
- otherwise returns false.
+ otherwise returns \c false.
\sa feature(), setFeature()
*/
@@ -2883,8 +2883,8 @@ void QXmlSimpleReaderPrivate::initIncrementalParsing()
/*!
\fn bool QXmlReader::hasProperty(const QString& name) const
- Returns true if the reader has the property \a name; otherwise
- returns false.
+ Returns \c true if the reader has the property \a name; otherwise
+ returns \c false.
\sa property(), setProperty()
*/
@@ -2997,8 +2997,8 @@ void QXmlSimpleReaderPrivate::initIncrementalParsing()
/*!
\fn bool QXmlReader::parse(const QXmlInputSource *input)
- Reads an XML document from \a input and parses it. Returns true if
- the parsing was successful; otherwise returns false.
+ Reads an XML document from \a input and parses it. Returns \c true if
+ the parsing was successful; otherwise returns \c false.
*/
@@ -3400,7 +3400,7 @@ bool QXmlSimpleReader::parse(const QXmlInputSource& input)
/*!
Reads an XML document from \a input and parses it in one pass (non-incrementally).
- Returns true if the parsing was successful; otherwise returns false.
+ Returns \c true if the parsing was successful; otherwise returns \c false.
*/
bool QXmlSimpleReader::parse(const QXmlInputSource* input)
{
@@ -3408,8 +3408,8 @@ bool QXmlSimpleReader::parse(const QXmlInputSource* input)
}
/*!
- Reads an XML document from \a input and parses it. Returns true
- if the parsing is completed successfully; otherwise returns false,
+ Reads an XML document from \a input and parses it. Returns \c true
+ if the parsing is completed successfully; otherwise returns \c false,
indicating that an error occurred.
If \a incremental is false, this function will return false if the XML
@@ -3463,7 +3463,7 @@ bool QXmlSimpleReader::parse(const QXmlInputSource *input, bool incremental)
call to parse(). To use this function, you \e must have called
parse() with the incremental argument set to true.
- Returns false if a parsing error occurs; otherwise returns true,
+ Returns \c false if a parsing error occurs; otherwise returns \c true,
even if the end of the XML file has not been reached. You can
continue parsing at a later stage by calling this function again
when there is more data available to parse.
@@ -7894,7 +7894,7 @@ bool QXmlSimpleReaderPrivate::parseString()
name. If \a inLiteral is true, the entity is IncludedInLiteral (i.e., " and '
must be quoted. Otherwise they are not quoted.
- This function returns false on error.
+ This function returns \c false on error.
*/
bool QXmlSimpleReaderPrivate::insertXmlRef(const QString &data, const QString &name, bool inLiteral)
{
@@ -7961,7 +7961,7 @@ void QXmlSimpleReaderPrivate::next()
This function does not move the cursor if the actual cursor position is a
non-whitespace charcter.
- Returns false when you use incremental parsing and this function reaches EOF
+ Returns \c false when you use incremental parsing and this function reaches EOF
with reading only whitespace characters. In this case it also poplulates the
parseStack with useful information. In all other cases, this function returns
true.
@@ -8025,8 +8025,8 @@ void QXmlSimpleReaderPrivate::initData()
}
/*
- Returns true if a entity with the name \a e exists,
- otherwise returns false.
+ Returns \c true if a entity with the name \a e exists,
+ otherwise returns \c false.
*/
bool QXmlSimpleReaderPrivate::entityExist(const QString& e) const
{