From 04133551a51213e48fe1972bcbcbdba53e24043b Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Tue, 17 Dec 2013 15:21:55 +0100 Subject: [PATCH] Doc: Move XML example documentation to correct location MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Moving the examples documentation to resolve doc linking issues. Task-number: QTBUG-34749 Change-Id: I2adb1b5d37911c7df6a78a03741d3d43ab24eafb Reviewed-by: Topi Reiniö --- .../doc/images/dombookmarks-example.png | Bin .../{ => dombookmarks}/doc/src/dombookmarks.qdoc | 1 + .../xml/xmlstreamlint/doc/src}/xmlstreamlint.qdoc | 9 +++++---- 3 files changed, 6 insertions(+), 4 deletions(-) rename examples/xml/{ => dombookmarks}/doc/images/dombookmarks-example.png (100%) rename examples/xml/{ => dombookmarks}/doc/src/dombookmarks.qdoc (98%) rename {doc/src/examples => examples/xml/xmlstreamlint/doc/src}/xmlstreamlint.qdoc (94%) diff --git a/examples/xml/doc/images/dombookmarks-example.png b/examples/xml/dombookmarks/doc/images/dombookmarks-example.png similarity index 100% rename from examples/xml/doc/images/dombookmarks-example.png rename to examples/xml/dombookmarks/doc/images/dombookmarks-example.png diff --git a/examples/xml/doc/src/dombookmarks.qdoc b/examples/xml/dombookmarks/doc/src/dombookmarks.qdoc similarity index 98% rename from examples/xml/doc/src/dombookmarks.qdoc rename to examples/xml/dombookmarks/doc/src/dombookmarks.qdoc index a30f66d94e0..f74856eb2c2 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 similarity index 94% rename from doc/src/examples/xmlstreamlint.qdoc rename to examples/xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc index 5ca51397813..376f074555c 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