1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: Move XML example documentation to correct location

Browse Source 
Moving the examples documentation to resolve doc linking
issues.

Task-number: QTBUG-34749
Change-Id: I2adb1b5d37911c7df6a78a03741d3d43ab24eafb
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
This commit is contained in:
Nico Vertriest 2013-12-17 15:21:55 +01:00 committed by The Qt Project
parent 4bbfedd353
commit 04133551a5
3 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
examples/xml/doc/images/dombookmarks-example.png → examples/xml/dombookmarks/doc/images/dombookmarks-example.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB

1
examples/xml/doc/src/dombookmarks.qdoc → examples/xml/dombookmarks/doc/src/dombookmarks.qdoc
View File

@ -28,6 +28,7 @@
/*! /*!
\example dombookmarks \example dombookmarks
\title DOM Bookmarks Example \title DOM Bookmarks Example
\ingroup xml-examples
The DOM Bookmarks example provides a reader for XML Bookmark Exchange Language (XBEL) 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 files that uses Qt's DOM-based XML API to read and parse the files. The SAX Bookmarks

9
doc/src/examples/xmlstreamlint.qdoc → examples/xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc
View File

@ -26,8 +26,9 @@
****************************************************************************/ ****************************************************************************/
/*! /*!
\example xml/xmlstreamlint \example xmlstreamlint
\title XML Stream Lint Example \title XML Stream Lint Example
\ingroup xml-examples
The XML Stream Lint example provides a simple command line utility that 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 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 operates on the input file object; writing is handled by an instance of
QXmlStreamWriter operating on the output file object: 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 The work of parsing and rewriting the XML is done in a while loop, and is
driven by input from the reader: 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 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 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 error file via a stream, and the example exits by returning a non-zero
value from the main function. 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, 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 and this is written to the output file that was specified when it was