summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@digia.com>2013-12-17 15:21:55 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-12-20 10:37:43 +0100
commit04133551a51213e48fe1972bcbcbdba53e24043b (patch)
tree78ea94fb029f51a49403aade7705af40a418f9c5
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ƶ <topi.reinio@digia.com>
-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
-rw-r--r--examples/xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc (renamed from doc/src/examples/xmlstreamlint.qdoc)9
3 files changed, 6 insertions, 4 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/doc/src/examples/xmlstreamlint.qdoc b/examples/xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc
index 5ca5139781..376f074555 100644
--- a/doc/src/examples/xmlstreamlint.qdoc
+++ b/examples/xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc
@@ -26,8 +26,9 @@
****************************************************************************/
/*!
- \example xml/xmlstreamlint
+ \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
@@ -49,19 +50,19 @@
operates on the input file object; writing is handled by an instance of
QXmlStreamWriter operating on the output file object:
- \snippet examples/xml/xmlstreamlint/main.cpp 0
+ \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 examples/xml/xmlstreamlint/main.cpp 1
+ \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 examples/xml/xmlstreamlint/main.cpp 2
+ \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