path: root/examples
diff options
authorNico Vertriest <>2013-12-17 15:21:55 +0100
committerThe Qt Project <>2013-12-20 10:37:43 +0100
commit04133551a51213e48fe1972bcbcbdba53e24043b (patch)
tree78ea94fb029f51a49403aade7705af40a418f9c5 /examples
parent4bbfedd35345915cef586c44683d459653c4315e (diff)
Doc: Move XML example documentation to correct location
Moving the examples documentation to resolve doc linking issues. Task-number: QTBUG-34749 Change-Id: I2adb1b5d37911c7df6a78a03741d3d43ab24eafb Reviewed-by: Topi Reiniƶ <>
Diffstat (limited to 'examples')
-rw-r--r--examples/xml/dombookmarks/doc/images/dombookmarks-example.png (renamed from examples/xml/doc/images/dombookmarks-example.png)bin19405 -> 19405 bytes
-rw-r--r--examples/xml/dombookmarks/doc/src/dombookmarks.qdoc (renamed from examples/xml/doc/src/dombookmarks.qdoc)1
3 files changed, 74 insertions, 0 deletions
diff --git a/examples/xml/doc/images/dombookmarks-example.png b/examples/xml/dombookmarks/doc/images/dombookmarks-example.png
index abacacbbfc..abacacbbfc 100644
--- a/examples/xml/doc/images/dombookmarks-example.png
+++ b/examples/xml/dombookmarks/doc/images/dombookmarks-example.png
Binary files differ
diff --git a/examples/xml/doc/src/dombookmarks.qdoc b/examples/xml/dombookmarks/doc/src/dombookmarks.qdoc
index a30f66d94e..f74856eb2c 100644
--- a/examples/xml/doc/src/dombookmarks.qdoc
+++ b/examples/xml/dombookmarks/doc/src/dombookmarks.qdoc
@@ -28,6 +28,7 @@
\example dombookmarks
\title DOM Bookmarks Example
+ \ingroup xml-examples
The DOM Bookmarks example provides a reader for XML Bookmark Exchange Language (XBEL)
files that uses Qt's DOM-based XML API to read and parse the files. The SAX Bookmarks
diff --git a/examples/xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc b/examples/xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc
new file mode 100644
index 0000000000..376f074555
--- /dev/null
+++ b/examples/xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc
@@ -0,0 +1,73 @@
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact:
+** This file is part of the documentation of the Qt Toolkit.
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia. For licensing terms and
+** conditions see For further information
+** use the contact form at
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met:
+ \example xmlstreamlint
+ \title XML Stream Lint Example
+ \ingroup xml-examples
+ The XML Stream Lint example provides a simple command line utility that
+ accepts a file name as its single argument and writes it to the standard
+ output file.
+ The specified file is parsed using an QXmlStreamReader object and written
+ to the standard output file using an QXmlStreamWriter object. If the file
+ does not contain a well-formed XML document or the use of namespaces in
+ the document is incorrect, a description of the error is printed to
+ the standard error file and will appear in the console.
+ \section1 Basic Operation
+ The main function of the example opens the file specified by the user
+ for input (\c inputFile), and it uses QFile to access the standard output
+ file.
+ Reading XML is handled by an instance of the QXmlStreamReader class, which
+ operates on the input file object; writing is handled by an instance of
+ QXmlStreamWriter operating on the output file object:
+ \snippet xmlstreamlint/main.cpp 0
+ The work of parsing and rewriting the XML is done in a while loop, and is
+ driven by input from the reader:
+ \snippet xmlstreamlint/main.cpp 1
+ If more input is available, the next token from the input file is read
+ and parsed. If an error occurred, information is written to the standard
+ error file via a stream, and the example exits by returning a non-zero
+ value from the main function.
+ \snippet xmlstreamlint/main.cpp 2
+ For valid input, the writer is fed the current token from the reader,
+ and this is written to the output file that was specified when it was
+ constructed.
+ When there is no more input, the loop terminates, and the example can
+ exit successfully.