diff options
author | Casper van Donderen <casper.vandonderen@nokia.com> | 2012-03-01 19:39:25 +0100 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-03-05 09:21:45 +0100 |
commit | 2efc7134d4caf48a2853cc606b9a9f31df996b43 (patch) | |
tree | 884252a2b4340fcd46427710056db74f985a90a3 /src/xmlpatterns | |
parent | 8cdd26295be30f951213ea511e96c2b4133be27e (diff) | |
download | qtxmlpatterns-2efc7134d4caf48a2853cc606b9a9f31df996b43.tar.gz |
Remove the usage of deprecated qdoc macros.
QDoc now has support for Doxygen style commands for italics, bold
and list items. This change applies that change in QDoc to the
actual documentation.
Task-number: QTBUG-24578
Change-Id: I453169a7222ee741f8d9a10b6c063be5d15f1b76
Reviewed-by: Honglei Zhang <honglei.zhang@nokia.com>
Diffstat (limited to 'src/xmlpatterns')
-rw-r--r-- | src/xmlpatterns/api/qabstractxmlforwarditerator.cpp | 4 | ||||
-rw-r--r-- | src/xmlpatterns/api/qabstractxmlnodemodel.cpp | 46 | ||||
-rw-r--r-- | src/xmlpatterns/api/qabstractxmlreceiver.cpp | 46 | ||||
-rw-r--r-- | src/xmlpatterns/api/qxmlname.cpp | 16 | ||||
-rw-r--r-- | src/xmlpatterns/api/qxmlquery.cpp | 32 | ||||
-rw-r--r-- | src/xmlpatterns/api/qxmlschema.cpp | 20 | ||||
-rw-r--r-- | src/xmlpatterns/api/qxmlschemavalidator.cpp | 20 | ||||
-rw-r--r-- | src/xmlpatterns/api/qxmlserializer.cpp | 8 |
8 files changed, 96 insertions, 96 deletions
diff --git a/src/xmlpatterns/api/qabstractxmlforwarditerator.cpp b/src/xmlpatterns/api/qabstractxmlforwarditerator.cpp index 094d53c..7d974e5 100644 --- a/src/xmlpatterns/api/qabstractxmlforwarditerator.cpp +++ b/src/xmlpatterns/api/qabstractxmlforwarditerator.cpp @@ -52,10 +52,10 @@ An item can be instantiated in QAbstractXmlForwardIterator if: \list - \o It has a default constructor, a copy constructor, and an + \li It has a default constructor, a copy constructor, and an assignment operator, and - \o It has an appropriate qIsForwardIteratorEnd() function. + \li It has an appropriate qIsForwardIteratorEnd() function. \endlist @ingroup Patternist_iterators diff --git a/src/xmlpatterns/api/qabstractxmlnodemodel.cpp b/src/xmlpatterns/api/qabstractxmlnodemodel.cpp index 6dfaad2..bc1d2a8 100644 --- a/src/xmlpatterns/api/qabstractxmlnodemodel.cpp +++ b/src/xmlpatterns/api/qabstractxmlnodemodel.cpp @@ -161,18 +161,18 @@ bool QAbstractXmlNodeModel::isIgnorableInDeepEqual(const QXmlNodeModelIndex &n) \list 1 - \o Instantiate QXmlQuery and give it the XQuery to be run; + \li Instantiate QXmlQuery and give it the XQuery to be run; - \o Instantiate a subclass of QAbstractXmlNodeModel or + \li Instantiate a subclass of QAbstractXmlNodeModel or QSimpleXmlNodeModel; - \o Retrieve a QXmlNodeModelIndex for the node in the model where + \li Retrieve a QXmlNodeModelIndex for the node in the model where the QXmlQuery should start the query; - \o Use QXmlQuery::bindVariable() to bind the QXmlNodeModelIndex + \li Use QXmlQuery::bindVariable() to bind the QXmlNodeModelIndex to \c {$variable name}; - \o Call one of the QXmlQuery evaluation functions to run the + \li Call one of the QXmlQuery evaluation functions to run the query. \endlist @@ -339,15 +339,15 @@ QAbstractXmlNodeModel::~QAbstractXmlNodeModel() \list - \o For document nodes, the base URI and the document URI are the same. + \li For document nodes, the base URI and the document URI are the same. - \o For elements, the base URI is the URI appearing in the element's + \li For elements, the base URI is the URI appearing in the element's \c xml:base attribute, if present, or it is resolved to the parent element's base URI. - \o Namespace nodes have no base URI. + \li Namespace nodes have no base URI. - \o The base URI for a processing instruction, comment, attribute, + \li The base URI for a processing instruction, comment, attribute, or text node is the base URI of the node's parent element. \endlist @@ -380,11 +380,11 @@ QAbstractXmlNodeModel::~QAbstractXmlNodeModel() \list - \o If \a n is a document node, return an absolute QUrl containing + \li If \a n is a document node, return an absolute QUrl containing the document URI, or a default constructed QUrl. The latter signals that no document URI is available for the document node. - \o For all other nodes, return a default constructed QUrl. + \li For all other nodes, return a default constructed QUrl. \endlist @@ -761,9 +761,9 @@ QAbstractXmlNodeModel::iterate(const QXmlNodeModelIndex &ni, cases by guaranteeing that it will never ask for: \list - \o Children or siblings for attributes. - \o Children for comments, processing instructions, and text nodes. - \o Siblings or parents for document nodes. + \li Children or siblings for attributes. + \li Children for comments, processing instructions, and text nodes. + \li Siblings or parents for document nodes. \endlist A typical implementation performs a \c switch on the value of \a @@ -895,19 +895,19 @@ void QAbstractXmlNodeModel::sendNamespaces(const QXmlNodeModelIndex &n, \list - \o For processing instructions, the string value is the data + \li For processing instructions, the string value is the data section(excluding any whitespace appearing between the name and the data). - \o For text nodes, the string value equals the text node. + \li For text nodes, the string value equals the text node. - \o For comments, the content of the comment + \li For comments, the content of the comment - \o For elements, the concatenation of all text nodes that are + \li For elements, the concatenation of all text nodes that are descendants. Note, this is not only the children, but the childrens' childrens' text nodes, and so forth. - \o For document nodes, the concatenation of all text nodes in the + \li For document nodes, the concatenation of all text nodes in the document. \endlist @@ -1308,9 +1308,9 @@ bool QXmlItem::isNull() const {XML node model}. It contains: \list - \o A pointer to an \l{QAbstractXmlNodeModel} {XML node model}, + \li A pointer to an \l{QAbstractXmlNodeModel} {XML node model}, which is returned by model(), and - \o Some data, which is returned by data(), internalPointer(), + \li Some data, which is returned by data(), internalPointer(), and additionalData(). \endlist @@ -1323,10 +1323,10 @@ bool QXmlItem::isNull() const \list - \o Send the output of your XQuery to an \l{QAbstractXmlReceiver} + \li Send the output of your XQuery to an \l{QAbstractXmlReceiver} {XML receiver}, or - \o Let your XQuery do all the work to produce the desired result. + \li Let your XQuery do all the work to produce the desired result. \endlist diff --git a/src/xmlpatterns/api/qabstractxmlreceiver.cpp b/src/xmlpatterns/api/qabstractxmlreceiver.cpp index 0daf24f..e8880b7 100644 --- a/src/xmlpatterns/api/qabstractxmlreceiver.cpp +++ b/src/xmlpatterns/api/qabstractxmlreceiver.cpp @@ -92,22 +92,22 @@ QT_BEGIN_NAMESPACE \list - \o An \e {Element Node} represents an XML element. + \li An \e {Element Node} represents an XML element. - \o An \e {Attribute Node} represents an XML attribute. + \li An \e {Attribute Node} represents an XML attribute. - \o A \e {Document Node} represents an entire XML document. + \li A \e {Document Node} represents an entire XML document. - \o A \e {Text Node} represents character data (element content). + \li A \e {Text Node} represents character data (element content). - \o A \e {Processing Instruction Node} represents an XML + \li A \e {Processing Instruction Node} represents an XML processing instruction, which is used in an XML document to tell the application reading the document to perform some action. A typical example is to use a processing instruction to tell the application to use a particular XSLT stylesheet to display the document. - \o And a \e {Comment node} represents an XML comment. + \li And a \e {Comment node} represents an XML comment. \endlist @@ -117,34 +117,34 @@ QT_BEGIN_NAMESPACE \list - \o Each \e node appears in the \e sequence before its children + \li Each \e node appears in the \e sequence before its children and their descendants appear. - \o A \e node's descendants appear in the \e sequence before + \li A \e node's descendants appear in the \e sequence before any of its siblings appear. - \o A \e {Document Node} represents an entire document. Zero or + \li A \e {Document Node} represents an entire document. Zero or more \e {Document Nodes} can appear in a \e sequence, but they can only be top level items (i.e., a \e {Document Node} can't be a child of another \e node. - \o \e {Namespace Nodes} immediately follow the \e {Element Node} + \li \e {Namespace Nodes} immediately follow the \e {Element Node} with which they are associated. - \o \e {Attribute Nodes} immediately follow the \e {Namespace Nodes} + \li \e {Attribute Nodes} immediately follow the \e {Namespace Nodes} of the element with which they are associated, or... - \o If there are no \e {Namespace Nodes} following an element, then + \li If there are no \e {Namespace Nodes} following an element, then the \e {Attribute Nodes} immediately follow the element. - \o An \e {atomic value} can only appear as a top level \e item, + \li An \e {atomic value} can only appear as a top level \e item, i.e., it can't appear as a child of a \e node. - \o \e {Processing Instruction Nodes} do not have children, and + \li \e {Processing Instruction Nodes} do not have children, and their parent is either a \e {Document Node} or an \e {Element Node}. - \o \e {Comment Nodes} do not have children, and + \li \e {Comment Nodes} do not have children, and their parent is either a \e {Document Node} or an \e {Element Node}. @@ -158,27 +158,27 @@ QT_BEGIN_NAMESPACE \list - \o startDocument() and endDocument() are called for each + \li startDocument() and endDocument() are called for each \e {Document Node} in the \e sequence. endDocument() is not called until all the \e {Document Node's} children have appeared in the \e sequence. - \o startElement() and endElement() are called for each + \li startElement() and endElement() are called for each \e {Element Node}. endElement() is not called until all the \e {Element Node's} children have appeared in the \e sequence. - \o attribute() is called for each \e {Attribute Node}. + \li attribute() is called for each \e {Attribute Node}. - \o comment() is called for each \e {Comment Node}. + \li comment() is called for each \e {Comment Node}. - \o characters() is called for each \e {Text Node}. + \li characters() is called for each \e {Text Node}. - \o processingInstruction() is called for each \e {Processing + \li processingInstruction() is called for each \e {Processing Instruction Node}. - \o namespaceBinding() is called for each \e {Namespace Node}. + \li namespaceBinding() is called for each \e {Namespace Node}. - \o atomicValue() is called for each \e {atomic value}. + \li atomicValue() is called for each \e {atomic value}. \endlist diff --git a/src/xmlpatterns/api/qxmlname.cpp b/src/xmlpatterns/api/qxmlname.cpp index 2a67ea5..53d8155 100644 --- a/src/xmlpatterns/api/qxmlname.cpp +++ b/src/xmlpatterns/api/qxmlname.cpp @@ -435,17 +435,17 @@ bool QXmlName::isNCName(const QString &candidate) \table \header - \o Clark Name - \o Description + \li Clark Name + \li Description \row - \o \c html - \o The local name \c html, in no namespace + \li \c html + \li The local name \c html, in no namespace \row - \o \c {http://www.w3.org/1999/xhtml}html - \o The local name \c html, in the XHTML namespace + \li \c {http://www.w3.org/1999/xhtml}html + \li The local name \c html, in the XHTML namespace \row - \o \c {http://www.w3.org/1999/xhtml}my:html - \o The local name \c html, in the XHTML namespace, with the prefix \c my + \li \c {http://www.w3.org/1999/xhtml}my:html + \li The local name \c html, in the XHTML namespace, with the prefix \c my \endtable If the namespace contains braces, the returned value is either invalid or diff --git a/src/xmlpatterns/api/qxmlquery.cpp b/src/xmlpatterns/api/qxmlquery.cpp index c8747ae..c254843 100644 --- a/src/xmlpatterns/api/qxmlquery.cpp +++ b/src/xmlpatterns/api/qxmlquery.cpp @@ -98,7 +98,7 @@ QT_BEGIN_NAMESPACE \list - \o evaluateTo(QAbstractXmlReceiver *) is called with a pointer to an + \li evaluateTo(QAbstractXmlReceiver *) is called with a pointer to an XML \l {QAbstractXmlReceiver} {receiver}, which receives the query results as a sequence of callbacks. The receiver callback class is like the callback class used for translating the output of a SAX @@ -110,7 +110,7 @@ QT_BEGIN_NAMESPACE \list - \o evaluateTo(QXmlResultItems *) is called with a pointer to an + \li evaluateTo(QXmlResultItems *) is called with a pointer to an iterator for an empty sequence of query \l {QXmlResultItems} {result items}. The Java-like iterator allows the query results to be accessed sequentially. @@ -119,7 +119,7 @@ QT_BEGIN_NAMESPACE \list - \o evaluateTo(QStringList *) is like evaluateTo(QXmlResultItems *), + \li evaluateTo(QStringList *) is like evaluateTo(QXmlResultItems *), but the query must evaluate to a sequence of strings. \endlist @@ -184,12 +184,12 @@ QT_BEGIN_NAMESPACE \list - \o The error message is sent to the messageHandler(). + \li The error message is sent to the messageHandler(). - \o QXmlResultItems::hasError() will return \c{true}, or + \li QXmlResultItems::hasError() will return \c{true}, or evaluateTo() will return \c{false}; - \o The results of the evaluation are undefined. + \li The results of the evaluation are undefined. \endlist @@ -345,24 +345,24 @@ QXmlQuery &QXmlQuery::operator=(const QXmlQuery &other) \table \header - \o message() argument - \o Semantics + \li message() argument + \li Semantics \row - \o QtMsgType type - \o Only QtWarningMsg and QtFatalMsg are used. The former + \li QtMsgType type + \li Only QtWarningMsg and QtFatalMsg are used. The former identifies a compile or runtime warning, while the latter identifies a dynamic or static error. \row - \o const QString & description - \o An XHTML document which is the actual message. It is translated + \li const QString & description + \li An XHTML document which is the actual message. It is translated into the current language. \row - \o const QUrl &identifier - \o Identifies the error with a URI, where the fragment is + \li const QUrl &identifier + \li Identifies the error with a URI, where the fragment is the error code, and the rest of the URI is the error namespace. \row - \o const QSourceLocation & sourceLocation - \o Identifies where the error occurred. + \li const QSourceLocation & sourceLocation + \li Identifies where the error occurred. \endtable */ diff --git a/src/xmlpatterns/api/qxmlschema.cpp b/src/xmlpatterns/api/qxmlschema.cpp index d3850c0..a1dfe7a 100644 --- a/src/xmlpatterns/api/qxmlschema.cpp +++ b/src/xmlpatterns/api/qxmlschema.cpp @@ -216,23 +216,23 @@ QUrl QXmlSchema::documentUri() const \table \header - \o message() argument - \o Semantics + \li message() argument + \li Semantics \row - \o QtMsgType type - \o Only QtWarningMsg and QtFatalMsg are used. The former + \li QtMsgType type + \li Only QtWarningMsg and QtFatalMsg are used. The former identifies a warning, while the latter identifies an error. \row - \o const QString & description - \o An XHTML document which is the actual message. It is translated + \li const QString & description + \li An XHTML document which is the actual message. It is translated into the current language. \row - \o const QUrl &identifier - \o Identifies the error with a URI, where the fragment is + \li const QUrl &identifier + \li Identifies the error with a URI, where the fragment is the error code, and the rest of the URI is the error namespace. \row - \o const QSourceLocation & sourceLocation - \o Identifies where the error occurred. + \li const QSourceLocation & sourceLocation + \li Identifies where the error occurred. \endtable */ diff --git a/src/xmlpatterns/api/qxmlschemavalidator.cpp b/src/xmlpatterns/api/qxmlschemavalidator.cpp index 2af6bae..ed867f9 100644 --- a/src/xmlpatterns/api/qxmlschemavalidator.cpp +++ b/src/xmlpatterns/api/qxmlschemavalidator.cpp @@ -254,23 +254,23 @@ QXmlSchema QXmlSchemaValidator::schema() const \table \header - \o message() argument - \o Semantics + \li message() argument + \li Semantics \row - \o QtMsgType type - \o Only QtWarningMsg and QtFatalMsg are used. The former + \li QtMsgType type + \li Only QtWarningMsg and QtFatalMsg are used. The former identifies a warning, while the latter identifies an error. \row - \o const QString & description - \o An XHTML document which is the actual message. It is translated + \li const QString & description + \li An XHTML document which is the actual message. It is translated into the current language. \row - \o const QUrl &identifier - \o Identifies the error with a URI, where the fragment is + \li const QUrl &identifier + \li Identifies the error with a URI, where the fragment is the error code, and the rest of the URI is the error namespace. \row - \o const QSourceLocation & sourceLocation - \o Identifies where the error occurred. + \li const QSourceLocation & sourceLocation + \li Identifies where the error occurred. \endtable */ diff --git a/src/xmlpatterns/api/qxmlserializer.cpp b/src/xmlpatterns/api/qxmlserializer.cpp index a50b161..ea77756 100644 --- a/src/xmlpatterns/api/qxmlserializer.cpp +++ b/src/xmlpatterns/api/qxmlserializer.cpp @@ -116,14 +116,14 @@ QXmlSerializerPrivate::QXmlSerializerPrivate(const QXmlQuery &query, QXmlSerializer will: \list - \o Declare namespaces when needed, + \li Declare namespaces when needed, - \o Use appropriate escaping, when characters can't be + \li Use appropriate escaping, when characters can't be represented in the XML, - \o Handle line endings appropriately, + \li Handle line endings appropriately, - \o Report errors, when it can't serialize the content, e.g., + \li Report errors, when it can't serialize the content, e.g., when asked to serialize an attribute that is a top-level node, or when more than one top-level element is encountered. |