From 8d9cb38a66e01356bd41d24e5e3b8b206065f941 Mon Sep 17 00:00:00 2001
From: Casper van Donderen <casper.vandonderen@nokia.com>
Date: Sat, 21 Apr 2012 09:17:40 +0200
Subject: Doc: Fix most QDoc errors in QtXml.

Changes:
- XML processing document moved from Qt XML Patterns.
- Moves documentation from /doc/src to /src/xml/doc
- Add new qdocconf file.

Change-Id: I4bc2104714a28905304997e5ff252e662ddf0bee
Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
---
 doc/src/snippets/code/doc_src_qtxml.cpp    |  43 ------
 doc/src/snippets/code/doc_src_qtxml.pro    |  43 ------
 doc/src/snippets/code/src_xml_dom_qdom.cpp | 218 -----------------------------
 doc/src/snippets/code/src_xml_sax_qxml.cpp |  43 ------
 4 files changed, 347 deletions(-)
 delete mode 100644 doc/src/snippets/code/doc_src_qtxml.cpp
 delete mode 100644 doc/src/snippets/code/doc_src_qtxml.pro
 delete mode 100644 doc/src/snippets/code/src_xml_dom_qdom.cpp
 delete mode 100644 doc/src/snippets/code/src_xml_sax_qxml.cpp

(limited to 'doc/src/snippets/code')

diff --git a/doc/src/snippets/code/doc_src_qtxml.cpp b/doc/src/snippets/code/doc_src_qtxml.cpp
deleted file mode 100644
index 976fffa1ae..0000000000
--- a/doc/src/snippets/code/doc_src_qtxml.cpp
+++ /dev/null
@@ -1,43 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
-** Contact: http://www.qt-project.org/
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:BSD$
-** You may use this file under the terms of the BSD license as follows:
-**
-** "Redistribution and use in source and binary forms, with or without
-** modification, are permitted provided that the following conditions are
-** met:
-**   * Redistributions of source code must retain the above copyright
-**     notice, this list of conditions and the following disclaimer.
-**   * Redistributions in binary form must reproduce the above copyright
-**     notice, this list of conditions and the following disclaimer in
-**     the documentation and/or other materials provided with the
-**     distribution.
-**   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
-**     the names of its contributors may be used to endorse or promote
-**     products derived from this software without specific prior written
-**     permission.
-**
-** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
-**
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-//! [0]
-#include <QtXml>
-//! [0]
diff --git a/doc/src/snippets/code/doc_src_qtxml.pro b/doc/src/snippets/code/doc_src_qtxml.pro
deleted file mode 100644
index b0a38e3432..0000000000
--- a/doc/src/snippets/code/doc_src_qtxml.pro
+++ /dev/null
@@ -1,43 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
-** Contact: http://www.qt-project.org/
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:BSD$
-** You may use this file under the terms of the BSD license as follows:
-**
-** "Redistribution and use in source and binary forms, with or without
-** modification, are permitted provided that the following conditions are
-** met:
-**   * Redistributions of source code must retain the above copyright
-**     notice, this list of conditions and the following disclaimer.
-**   * Redistributions in binary form must reproduce the above copyright
-**     notice, this list of conditions and the following disclaimer in
-**     the documentation and/or other materials provided with the
-**     distribution.
-**   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
-**     the names of its contributors may be used to endorse or promote
-**     products derived from this software without specific prior written
-**     permission.
-**
-** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
-**
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-#! [1]
-QT += xml
-#! [1]
diff --git a/doc/src/snippets/code/src_xml_dom_qdom.cpp b/doc/src/snippets/code/src_xml_dom_qdom.cpp
deleted file mode 100644
index f8c2382f04..0000000000
--- a/doc/src/snippets/code/src_xml_dom_qdom.cpp
+++ /dev/null
@@ -1,218 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
-** Contact: http://www.qt-project.org/
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:BSD$
-** You may use this file under the terms of the BSD license as follows:
-**
-** "Redistribution and use in source and binary forms, with or without
-** modification, are permitted provided that the following conditions are
-** met:
-**   * Redistributions of source code must retain the above copyright
-**     notice, this list of conditions and the following disclaimer.
-**   * Redistributions in binary form must reproduce the above copyright
-**     notice, this list of conditions and the following disclaimer in
-**     the documentation and/or other materials provided with the
-**     distribution.
-**   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
-**     the names of its contributors may be used to endorse or promote
-**     products derived from this software without specific prior written
-**     permission.
-**
-** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
-**
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-//! [0]
-QDomDocument doc;
-QDomImplementation impl;
-
-// This will create the element, but the resulting XML document will
-// be invalid, because '~' is not a valid character in a tag name.
-impl.setInvalidDataPolicy(QDomImplementation::AcceptInvalidData);
-QDomElement elt1 = doc.createElement("foo~bar");
-
-// This will create an element with the tag name "foobar".
-impl.setInvalidDataPolicy(QDomImplementation::DropInvalidData);
-QDomElement elt2 = doc.createElement("foo~bar");
-
-// This will create a null element.
-impl.setInvalidDataPolicy(QDomImplementation::ReturnNullNode);
-QDomElement elt3 = doc.createElement("foo~bar");
-//! [0]
-
-
-//! [1]
-QDomDocument d;
-d.setContent(someXML);
-QDomNode n = d.firstChild();
-while (!n.isNull()) {
-    if (n.isElement()) {
-        QDomElement e = n.toElement();
-        cout << "Element name: " << e.tagName() << endl;
-        break;
-    }
-    n = n.nextSibling();
-}
-//! [1]
-
-
-//! [2]
-QDomDocument document;
-QDomElement element1 = document.documentElement();
-QDomElement element2 = element1;
-//! [2]
-
-
-//! [3]
-QDomElement element3 = document.createElement("MyElement");
-QDomElement element4 = document.createElement("MyElement");
-//! [3]
-
-
-//! [4]
-<body>
-<h1>Heading</h1>
-<p>Hello <b>you</b></p>
-</body>
-//! [4]
-
-
-//! [5]
-<h1>Heading</h1>
-<p>The text...</p>
-<h2>Next heading</h2>
-//! [5]
-
-
-//! [6]
-<h1>Heading</h1>
-<p>The text...</p>
-<h2>Next heading</h2>
-//! [6]
-
-
-//! [7]
-<link href="http://qt.nokia.com" color="red" />
-//! [7]
-
-
-//! [8]
-QDomElement e = //...
-//...
-QDomAttr a = e.attributeNode("href");
-cout << a.value() << endl;                // prints "http://qt.nokia.com"
-a.setValue("http://qt.nokia.com/doc"); // change the node's attribute
-QDomAttr a2 = e.attributeNode("href");
-cout << a2.value() << endl;               // prints "http://qt.nokia.com/doc"
-//! [8]
-
-
-//! [9]
-QDomElement e = //...
-//...
-QString s = e.text()
-//! [9]
-
-
-//! [10]
-QString text;
-QDomElement element = doc.documentElement();
-for(QDomNode n = element.firstChild(); !n.isNull(); n = n.nextSibling())
-{
-    QDomText t = n.toText();
-    if (!t.isNull())
-        text += t.data();
-}
-//! [10]
-
-
-//! [11]
-QDomDocument doc = // ...
-QDomElement root = doc.firstChildElement("database");
-QDomElement elt = root.firstChildElement("entry");
-for (; !elt.isNull(); elt = elt.nextSiblingElement("entry")) {
-    // ...
-}
-//! [11]
-
-
-//! [12]
-<img src="myimg.png">
-//! [12]
-
-
-//! [13]
-<h1>Hello <b>Qt</b> <![CDATA[<xml is cool>]]></h1>
-//! [13]
-
-
-//! [14]
-Hello Qt <xml is cool>
-//! [14]
-
-
-//! [15]
-<!-- this is a comment -->
-//! [15]
-
-
-//! [16]
-QDomDocument doc("mydocument");
-QFile file("mydocument.xml");
-if (!file.open(QIODevice::ReadOnly))
-    return;
-if (!doc.setContent(&file)) {
-    file.close();
-    return;
-}
-file.close();
-
-// print out the element names of all elements that are direct children
-// of the outermost element.
-QDomElement docElem = doc.documentElement();
-
-QDomNode n = docElem.firstChild();
-while(!n.isNull()) {
-    QDomElement e = n.toElement(); // try to convert the node to an element.
-    if(!e.isNull()) {
-        cout << qPrintable(e.tagName()) << endl; // the node really is an element.
-    }
-    n = n.nextSibling();
-}
-
-// Here we append a new element to the end of the document
-QDomElement elem = doc.createElement("img");
-elem.setAttribute("src", "myimage.png");
-docElem.appendChild(elem);
-//! [16]
-
-
-//! [17]
-QDomDocument doc("MyML");
-QDomElement root = doc.createElement("MyML");
-doc.appendChild(root);
-
-QDomElement tag = doc.createElement("Greeting");
-root.appendChild(tag);
-
-QDomText t = doc.createTextNode("Hello World");
-tag.appendChild(t);
-
-QString xml = doc.toString();
-//! [17]
diff --git a/doc/src/snippets/code/src_xml_sax_qxml.cpp b/doc/src/snippets/code/src_xml_sax_qxml.cpp
deleted file mode 100644
index 4b9dc4a129..0000000000
--- a/doc/src/snippets/code/src_xml_sax_qxml.cpp
+++ /dev/null
@@ -1,43 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
-** Contact: http://www.qt-project.org/
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:BSD$
-** You may use this file under the terms of the BSD license as follows:
-**
-** "Redistribution and use in source and binary forms, with or without
-** modification, are permitted provided that the following conditions are
-** met:
-**   * Redistributions of source code must retain the above copyright
-**     notice, this list of conditions and the following disclaimer.
-**   * Redistributions in binary form must reproduce the above copyright
-**     notice, this list of conditions and the following disclaimer in
-**     the documentation and/or other materials provided with the
-**     distribution.
-**   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
-**     the names of its contributors may be used to endorse or promote
-**     products derived from this software without specific prior written
-**     permission.
-**
-** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
-**
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-//! [0]
-xmlReader.setFeature("http://xml.org/sax/features/namespace-prefixes", true);
-//! [0]
-- 
cgit v1.2.3