From 0bc02fd0d61d1e4aed9b39890d28975dff30e822 Mon Sep 17 00:00:00 2001 From: Casper van Donderen Date: Tue, 20 Mar 2012 19:37:07 +0100 Subject: Doc: Prepare for building modular QtCore docs. This change fixes most qdoc errors in QtCore. There are about 900 left. The main thing this change does is moving documentation from qtcore from /doc/src to /src/corelib/doc. Other issues resolved are mis-use of qdoc commands. Change-Id: I002d01edfb13575e8bf27ce91596a577a92562d1 Reviewed-by: Lars Knoll Reviewed-by: Jason McDonald Reviewed-by: Jerome Pasion --- src/corelib/xml/qxmlstream.cpp | 12 ++++++------ src/corelib/xml/qxmlutils.cpp | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) (limited to 'src/corelib/xml') diff --git a/src/corelib/xml/qxmlstream.cpp b/src/corelib/xml/qxmlstream.cpp index df2c2f998f..769cdc9495 100644 --- a/src/corelib/xml/qxmlstream.cpp +++ b/src/corelib/xml/qxmlstream.cpp @@ -291,7 +291,7 @@ QXmlStreamEntityResolver *QXmlStreamReader::entityResolver() const A typical loop with QXmlStreamReader looks like this: - \snippet doc/src/snippets/code/src_corelib_xml_qxmlstream.cpp 0 + \snippet code/src_corelib_xml_qxmlstream.cpp 0 QXmlStreamReader is a well-formed XML 1.0 parser that does \e not @@ -2900,11 +2900,11 @@ QStringRef QXmlStreamReader::documentEncoding() const The following abridged code snippet shows the basic use of the class to write formatted XML with indentation: - \snippet doc/src/snippets/qxmlstreamwriter/main.cpp start stream + \snippet qxmlstreamwriter/main.cpp start stream \dots - \snippet doc/src/snippets/qxmlstreamwriter/main.cpp write element + \snippet qxmlstreamwriter/main.cpp write element \dots - \snippet doc/src/snippets/qxmlstreamwriter/main.cpp finish stream + \snippet qxmlstreamwriter/main.cpp finish stream QXmlStreamWriter takes care of prefixing namespaces, all you have to do is specify the \c namespaceUri when writing elements or @@ -3561,7 +3561,7 @@ void QXmlStreamWriter::writeEmptyElement(const QString &namespaceUri, const QStr This is a convenience function equivalent to: - \snippet doc/src/snippets/code/src_corelib_xml_qxmlstream.cpp 1 + \snippet code/src_corelib_xml_qxmlstream.cpp 1 */ void QXmlStreamWriter::writeTextElement(const QString &qualifiedName, const QString &text) @@ -3578,7 +3578,7 @@ void QXmlStreamWriter::writeTextElement(const QString &qualifiedName, const QStr This is a convenience function equivalent to: - \snippet doc/src/snippets/code/src_corelib_xml_qxmlstream.cpp 2 + \snippet code/src_corelib_xml_qxmlstream.cpp 2 */ void QXmlStreamWriter::writeTextElement(const QString &namespaceUri, const QString &name, const QString &text) diff --git a/src/corelib/xml/qxmlutils.cpp b/src/corelib/xml/qxmlutils.cpp index 7ec208816c..89912b42fa 100644 --- a/src/corelib/xml/qxmlutils.cpp +++ b/src/corelib/xml/qxmlutils.cpp @@ -227,7 +227,7 @@ bool QXmlUtils::isBaseChar(const QChar c) Determines whether \a encName is a valid instance of production [81]EncName in the XML 1.0 specification. If it is, true is returned, otherwise false. - \sa \l {http://www.w3.org/TR/REC-xml/#NT-EncName} + \sa {http://www.w3.org/TR/REC-xml/#NT-EncName}, {Extensible Markup Language (XML) 1.0 (Fourth Edition), [81] EncName} */ bool QXmlUtils::isEncName(const QString &encName) @@ -248,7 +248,7 @@ bool QXmlUtils::isEncName(const QString &encName) Determines whether \a c is a valid instance of production [84]Letter in the XML 1.0 specification. If it is, true is returned, otherwise false. - \sa \l {http://www.w3.org/TR/REC-xml/#NT-Letter} + \sa {http://www.w3.org/TR/REC-xml/#NT-Letter}, {Extensible Markup Language (XML) 1.0 (Fourth Edition), [84] Letter} */ bool QXmlUtils::isLetter(const QChar c) @@ -262,7 +262,7 @@ bool QXmlUtils::isLetter(const QChar c) Determines whether \a c is a valid instance of production [2]Char in the XML 1.0 specification. If it is, true is returned, otherwise false. - \sa \l {http://www.w3.org/TR/REC-xml/#NT-Char} + \sa {http://www.w3.org/TR/REC-xml/#NT-Char}, {Extensible Markup Language (XML) 1.0 (Fourth Edition), [2] Char} */ bool QXmlUtils::isChar(const QChar c) @@ -281,7 +281,7 @@ bool QXmlUtils::isChar(const QChar c) production [4]NameChar in the XML 1.0 specification. If it is, true is returned, otherwise false. - \sa \l {http://www.w3.org/TR/REC-xml/#NT-NameChar} + \sa {http://www.w3.org/TR/REC-xml/#NT-NameChar}, {Extensible Markup Language (XML) 1.0 (Fourth Edition), [4] NameChar} */ bool QXmlUtils::isNameChar(const QChar c) @@ -304,7 +304,7 @@ bool QXmlUtils::isNameChar(const QChar c) production [12] PubidLiteral in the XML 1.0 specification. If it is, true is returned, otherwise false. - \sa \l {http://www.w3.org/TR/REC-xml/#NT-PubidLiteral} + \sa {http://www.w3.org/TR/REC-xml/#NT-PubidLiteral}, {Extensible Markup Language (XML) 1.0 (Fourth Edition), [12] PubidLiteral} */ bool QXmlUtils::isPublicID(const QString &candidate) @@ -363,7 +363,7 @@ bool QXmlUtils::isPublicID(const QString &candidate) production [4]NCName in the XML 1.0 Namespaces specification. If it is, true is returned, otherwise false. - \sa \l {http://www.w3.org/TR/REC-xml-names/#NT-NCName} + \sa {http://www.w3.org/TR/REC-xml-names/#NT-NCName}, {W3CNamespaces in XML 1.0 (Second Edition), [4] NCName} */ bool QXmlUtils::isNCName(const QStringRef &ncName) -- cgit v1.2.3