summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorArnab Datta <arnab.datta@nokia.com>2012-03-30 16:33:48 +0200
committerQt by Nokia <qt-info@nokia.com>2012-04-13 13:08:08 +0200
commit08a3b2ea08480ef2f5b4ebc9d9a1442d45e1fa4c (patch)
treed6590c2e805d5d2600059ec3c8136b06e0f14880 /src
parent0d6c28c5eb7046bbc011b060fdcab1f622ed9f9a (diff)
downloadqtxmlpatterns-08a3b2ea08480ef2f5b4ebc9d9a1442d45e1fa4c.tar.gz
Fixed all qdoc errors for this module (except those related to linking)
Change-Id: I36d07a02ec8dea6bc2d538f32b28b987635c32c1 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
Diffstat (limited to 'src')
-rw-r--r--src/xmlpatterns/api/qabstracturiresolver.cpp2
-rw-r--r--src/xmlpatterns/api/qabstractxmlforwarditerator.cpp2
-rw-r--r--src/xmlpatterns/api/qabstractxmlnodemodel.cpp6
-rw-r--r--src/xmlpatterns/api/qabstractxmlreceiver.cpp4
-rw-r--r--src/xmlpatterns/api/qxmlformatter.cpp6
-rw-r--r--src/xmlpatterns/api/qxmlname.cpp8
-rw-r--r--src/xmlpatterns/api/qxmlquery.cpp12
-rw-r--r--src/xmlpatterns/api/qxmlresultitems.cpp2
-rw-r--r--src/xmlpatterns/api/qxmlschema.cpp8
-rw-r--r--src/xmlpatterns/api/qxmlschemavalidator.cpp8
-rw-r--r--src/xmlpatterns/api/qxmlserializer.cpp2
11 files changed, 30 insertions, 30 deletions
diff --git a/src/xmlpatterns/api/qabstracturiresolver.cpp b/src/xmlpatterns/api/qabstracturiresolver.cpp
index 3a3d61e..485ea80 100644
--- a/src/xmlpatterns/api/qabstracturiresolver.cpp
+++ b/src/xmlpatterns/api/qabstracturiresolver.cpp
@@ -102,7 +102,7 @@ QAbstractUriResolver::~QAbstractUriResolver()
about resolving the \a relative URI, it should simply return the \a
relative URI resolved against the \a baseURI, i.e.:
- \snippet doc/src/snippets/code/src_xmlpatterns_api_qabstracturiresolver.cpp 0
+ \snippet code/src_xmlpatterns_api_qabstracturiresolver.cpp 0
\sa QUrl::isRelative(), QUrl::isValid()
*/
diff --git a/src/xmlpatterns/api/qabstractxmlforwarditerator.cpp b/src/xmlpatterns/api/qabstractxmlforwarditerator.cpp
index d2d0a69..03c0eaf 100644
--- a/src/xmlpatterns/api/qabstractxmlforwarditerator.cpp
+++ b/src/xmlpatterns/api/qabstractxmlforwarditerator.cpp
@@ -228,7 +228,7 @@
that is converted to OutputType by calling a function on Derived
that has the following signature:
- \snippet doc/src/snippets/code/src_xmlpatterns_api_qabstractxmlforwarditerator.cpp 0
+ \snippet code/src_xmlpatterns_api_qabstractxmlforwarditerator.cpp 0
TODO Document why this class doesn't duplicate ItemMappingIterator.
*/
diff --git a/src/xmlpatterns/api/qabstractxmlnodemodel.cpp b/src/xmlpatterns/api/qabstractxmlnodemodel.cpp
index f300bc0..5ca544c 100644
--- a/src/xmlpatterns/api/qabstractxmlnodemodel.cpp
+++ b/src/xmlpatterns/api/qabstractxmlnodemodel.cpp
@@ -110,7 +110,7 @@ bool QAbstractXmlNodeModel::isIgnorableInDeepEqual(const QXmlNodeModelIndex &n)
present it through the \l
{http://www.w3.org/TR/xpath-datamodel/}{XPath Data Model interface}.
- \snippet doc/src/snippets/code/src_xmlpatterns_api_qabstractxmlnodemodel.cpp 1
+ \snippet code/src_xmlpatterns_api_qabstractxmlnodemodel.cpp 1
The application first creates an instance of QXmlQuery and calls \l
{QXmlQuery::setQuery()}{setQuery()} to read \c queryFile containing
@@ -1105,7 +1105,7 @@ bool QAbstractXmlNodeModel::isDeepEqual(const QXmlNodeModelIndex &n1,
each item is either an XML node or an atomic value. The query in the
following snippet evaluates to sequence of five items.
- \quotefile doc/src/snippets/patternist/items.xq
+ \quotefile patternist/items.xq
The five items are: An element, an atomic value (binary data encoded
in base64), a date, a float, and an attribute.
@@ -1495,7 +1495,7 @@ bool QXmlNodeModelIndex::operator!=(const QXmlNodeModelIndex &other) const
Resets this QXmlNodeModelIndex to be null. It is equivalent to
writing:
- \snippet doc/src/snippets/code/src_xmlpatterns_api_qabstractxmlnodemodel.cpp 0
+ \snippet code/src_xmlpatterns_api_qabstractxmlnodemodel.cpp 0
*/
/*!
diff --git a/src/xmlpatterns/api/qabstractxmlreceiver.cpp b/src/xmlpatterns/api/qabstractxmlreceiver.cpp
index 90d5d9c..0e095d4 100644
--- a/src/xmlpatterns/api/qabstractxmlreceiver.cpp
+++ b/src/xmlpatterns/api/qabstractxmlreceiver.cpp
@@ -63,7 +63,7 @@ QT_BEGIN_NAMESPACE
transforming that sequence into a structure of your choosing,
usually XML. Consider the example:
- \snippet doc/src/snippets/code/src_xmlpatterns_api_qabstractxmlreceiver.cpp 0
+ \snippet code/src_xmlpatterns_api_qabstractxmlreceiver.cpp 0
First it constructs a \l {QXmlQuery} {query} that gets the
first paragraph from document \c index.html. Then it constructs
@@ -316,7 +316,7 @@ allow null QUrls.
processing instruction to tell the application to use a
particular XSLT stylesheet to process the document.
- \quotefile doc/src/snippets/patternist/xmlStylesheet.xq
+ \quotefile patternist/xmlStylesheet.xq
\a target is the \l {QXmlName} {name} of the processing
instruction. Its \e prefix and \e {namespace URI} must both
diff --git a/src/xmlpatterns/api/qxmlformatter.cpp b/src/xmlpatterns/api/qxmlformatter.cpp
index 7ed77af..619120f 100644
--- a/src/xmlpatterns/api/qxmlformatter.cpp
+++ b/src/xmlpatterns/api/qxmlformatter.cpp
@@ -100,11 +100,11 @@ QXmlFormatterPrivate::QXmlFormatterPrivate(const QXmlQuery &query,
For example, where the base class QXmlSerializer would
output this:
- \quotefile doc/src/snippets/patternist/notIndented.xml
+ \quotefile patternist/notIndented.xml
QXmlFormatter outputs this:
- \quotefile doc/src/snippets/patternist/indented.xml
+ \quotefile patternist/indented.xml
If you just want to serialize your XML in a human-readable
format, use QXmlFormatter as it is. The default indentation
@@ -129,7 +129,7 @@ QXmlFormatterPrivate::QXmlFormatterPrivate(const QXmlQuery &query,
Alternatively, you can subclass QXmlFormatter and reimplement
the callbacks there.
- \snippet doc/src/snippets/code/src_xmlpatterns_api_qxmlformatter.cpp 0
+ \snippet code/src_xmlpatterns_api_qxmlformatter.cpp 0
*/
/*!
diff --git a/src/xmlpatterns/api/qxmlname.cpp b/src/xmlpatterns/api/qxmlname.cpp
index 19f1437..97b1921 100644
--- a/src/xmlpatterns/api/qxmlname.cpp
+++ b/src/xmlpatterns/api/qxmlname.cpp
@@ -75,7 +75,7 @@ QT_BEGIN_NAMESPACE
URI}, the \e {local name}, and the \e {prefix}. To see what these
refer to in XML, consider the following snippet.
- \quotefile doc/src/snippets/patternist/mobeyDick.xml
+ \quotefile patternist/mobeyDick.xml
For the element named \e book, localName() returns \e book,
namespaceUri() returns \e http://example.com/MyDefault,
@@ -123,9 +123,9 @@ QT_BEGIN_NAMESPACE
used in name comparisons. For example, the following two element
nodes represent the same element and compare equal.
- \quotefile doc/src/snippets/patternist/svgDocumentElement.xml
+ \quotefile patternist/svgDocumentElement.xml
- \quotefile doc/src/snippets/patternist/xsvgDocumentElement.xml
+ \quotefile patternist/xsvgDocumentElement.xml
Although the second name has the prefix \e x, the two names compare
equal as instances of QXmlName, because the prefix is not used in
@@ -150,7 +150,7 @@ QT_BEGIN_NAMESPACE
Setting of the mask enums use essentially this:
- \quotefile doc/src/snippets/code/src_xmlpatterns_api_qxmlname.cpp
+ \quotefile code/src_xmlpatterns_api_qxmlname.cpp
The masks, such as LocalNameMask, are positive. That is, for the
area which the name resides, the bits are set.
diff --git a/src/xmlpatterns/api/qxmlquery.cpp b/src/xmlpatterns/api/qxmlquery.cpp
index b98d44d..d4c11a3 100644
--- a/src/xmlpatterns/api/qxmlquery.cpp
+++ b/src/xmlpatterns/api/qxmlquery.cpp
@@ -77,7 +77,7 @@ QT_BEGIN_NAMESPACE
{http://www.w3.org/TR/xpath-datamodel/} {XQuery 1.0 and XPath 2.0
Data Model}.
- \snippet doc/src/snippets/code/src_xmlpatterns_api_qabstractxmlreceiver.cpp 0
+ \snippet code/src_xmlpatterns_api_qabstractxmlreceiver.cpp 0
The example uses QXmlQuery to match the first paragraph of an XML
document and then \l {QXmlSerializer} {output the result} to a
@@ -139,7 +139,7 @@ QT_BEGIN_NAMESPACE
an XSLT stylesheet instead of as an XQuery. You must also set the
input document by calling setFocus().
- \snippet doc/src/snippets/code/src_xmlpatterns_api_qxmlquery.cpp 7
+ \snippet code/src_xmlpatterns_api_qxmlquery.cpp 7
\note Currently, setFocus() must be called \e before setQuery() when
using XSLT.
@@ -552,7 +552,7 @@ void QXmlQuery::bindVariable(const QXmlName &name, const QXmlItem &value)
query's \l {QXmlNamePool} {namespace}. The function then behaves as
the overloaded function. It is equivalent to the following snippet.
- \snippet doc/src/snippets/code/src_xmlpatterns_api_qxmlquery.cpp 0
+ \snippet code/src_xmlpatterns_api_qxmlquery.cpp 0
*/
void QXmlQuery::bindVariable(const QString &localName, const QXmlItem &value)
{
@@ -567,7 +567,7 @@ void QXmlQuery::bindVariable(const QString &localName, const QXmlItem &value)
this function can be used to pass an XML document in memory to
\c{fn:doc}.
- \snippet doc/src/snippets/code/src_xmlpatterns_api_qxmlquery.cpp 1
+ \snippet code/src_xmlpatterns_api_qxmlquery.cpp 1
The caller must ensure that \a device has been opened with at least
QIODevice::ReadOnly prior to this binding. Otherwise, behavior is
@@ -577,7 +577,7 @@ void QXmlQuery::bindVariable(const QString &localName, const QXmlItem &value)
a QBuffer as shown in the following snippet. Suppose \e myQString
contains \c{<document>content</document>}
- \snippet doc/src/snippets/qxmlquery/bindingExample.cpp 0
+ \snippet qxmlquery/bindingExample.cpp 0
\a name must not be \e null. \a {name}.isNull() must return false.
If \a name has already been bound, its previous binding will be
@@ -638,7 +638,7 @@ void QXmlQuery::bindVariable(const QXmlName &name, QIODevice *device)
If \a localName is a valid \l {QXmlName::isNCName()} {NCName}, this
function is equivalent to the following snippet.
- \snippet doc/src/snippets/code/src_xmlpatterns_api_qxmlquery.cpp 2
+ \snippet code/src_xmlpatterns_api_qxmlquery.cpp 2
A QXmlName is constructed from \a localName, and is passed
to the appropriate overload along with \a device.
diff --git a/src/xmlpatterns/api/qxmlresultitems.cpp b/src/xmlpatterns/api/qxmlresultitems.cpp
index 48bac08..308b162 100644
--- a/src/xmlpatterns/api/qxmlresultitems.cpp
+++ b/src/xmlpatterns/api/qxmlresultitems.cpp
@@ -58,7 +58,7 @@ QT_BEGIN_NAMESPACE
repeatedly calling next(), which actually produces the sequence by
lazy evaluation of the query.
- \snippet doc/src/snippets/code/src_xmlpatterns_api_qxmlresultitems.cpp 0
+ \snippet code/src_xmlpatterns_api_qxmlresultitems.cpp 0
An effect of letting next() produce the sequence by lazy evaluation
is that a query error can occur on any call to next(). If an error
diff --git a/src/xmlpatterns/api/qxmlschema.cpp b/src/xmlpatterns/api/qxmlschema.cpp
index 00a4b69..3de9735 100644
--- a/src/xmlpatterns/api/qxmlschema.cpp
+++ b/src/xmlpatterns/api/qxmlschema.cpp
@@ -64,7 +64,7 @@ QT_BEGIN_NAMESPACE
The following example shows how to load a XML Schema file from the network
and test whether it is a valid schema document:
- \snippet doc/src/snippets/qxmlschema/main.cpp 0
+ \snippet qxmlschema/main.cpp 0
\section1 XML Schema Version
@@ -109,7 +109,7 @@ QXmlSchema::~QXmlSchema()
Example:
- \snippet doc/src/snippets/qxmlschema/main.cpp 0
+ \snippet qxmlschema/main.cpp 0
\sa isValid()
*/
@@ -137,7 +137,7 @@ bool QXmlSchema::load(const QUrl &source)
Example:
- \snippet doc/src/snippets/qxmlschema/main.cpp 1
+ \snippet qxmlschema/main.cpp 1
\sa isValid()
*/
@@ -163,7 +163,7 @@ bool QXmlSchema::load(QIODevice *source, const QUrl &documentUri)
Example:
- \snippet doc/src/snippets/qxmlschema/main.cpp 2
+ \snippet qxmlschema/main.cpp 2
\sa isValid()
*/
diff --git a/src/xmlpatterns/api/qxmlschemavalidator.cpp b/src/xmlpatterns/api/qxmlschemavalidator.cpp
index 4a724e8..bbf8d9d 100644
--- a/src/xmlpatterns/api/qxmlschemavalidator.cpp
+++ b/src/xmlpatterns/api/qxmlschemavalidator.cpp
@@ -70,7 +70,7 @@ QT_BEGIN_NAMESPACE
file, check whether it is a valid schema document and use it for validation
of an XML instance document:
- \snippet doc/src/snippets/qxmlschemavalidator/main.cpp 3
+ \snippet qxmlschemavalidator/main.cpp 3
\section1 XML Schema Version
@@ -129,7 +129,7 @@ void QXmlSchemaValidator::setSchema(const QXmlSchema &schema)
Example:
- \snippet doc/src/snippets/qxmlschemavalidator/main.cpp 2
+ \snippet qxmlschemavalidator/main.cpp 2
*/
bool QXmlSchemaValidator::validate(const QByteArray &data, const QUrl &documentUri) const
{
@@ -149,7 +149,7 @@ bool QXmlSchemaValidator::validate(const QByteArray &data, const QUrl &documentU
Example:
- \snippet doc/src/snippets/qxmlschemavalidator/main.cpp 0
+ \snippet qxmlschemavalidator/main.cpp 0
*/
bool QXmlSchemaValidator::validate(const QUrl &source) const
{
@@ -174,7 +174,7 @@ bool QXmlSchemaValidator::validate(const QUrl &source) const
Example:
- \snippet doc/src/snippets/qxmlschemavalidator/main.cpp 1
+ \snippet qxmlschemavalidator/main.cpp 1
*/
bool QXmlSchemaValidator::validate(QIODevice *source, const QUrl &documentUri) const
{
diff --git a/src/xmlpatterns/api/qxmlserializer.cpp b/src/xmlpatterns/api/qxmlserializer.cpp
index f43773c..51af1fc 100644
--- a/src/xmlpatterns/api/qxmlserializer.cpp
+++ b/src/xmlpatterns/api/qxmlserializer.cpp
@@ -102,7 +102,7 @@ QXmlSerializerPrivate::QXmlSerializerPrivate(const QXmlQuery &query,
QXmlSerializer translates an \l {XQuery Sequence} {XQuery sequence}, usually
the output of an QXmlQuery, into XML. Consider the example:
- \snippet doc/src/snippets/code/src_xmlpatterns_api_qxmlserializer.cpp 0
+ \snippet code/src_xmlpatterns_api_qxmlserializer.cpp 0
First it constructs a \l {QXmlQuery} {query} that gets the
first paragraph from document \c index.html. Then it constructs