From 04133551a51213e48fe1972bcbcbdba53e24043b Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Tue, 17 Dec 2013 15:21:55 +0100 Subject: 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/src/examples/xmlstreamlint.qdoc | 72 ------------------------------------- 1 file changed, 72 deletions(-) delete mode 100644 doc/src/examples/xmlstreamlint.qdoc (limited to 'doc/src') diff --git a/doc/src/examples/xmlstreamlint.qdoc b/doc/src/examples/xmlstreamlint.qdoc deleted file mode 100644 index 5ca5139781..0000000000 --- a/doc/src/examples/xmlstreamlint.qdoc +++ /dev/null @@ -1,72 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). -** Contact: http://www.qt-project.org/legal -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** 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 http://qt.digia.com/licensing. For further information -** use the contact form at http://qt.digia.com/contact-us. -** -** 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: http://www.gnu.org/copyleft/fdl.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \example xml/xmlstreamlint - \title XML Stream Lint Example - - 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 examples/xml/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 - - 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 - - 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. -*/ -- cgit v1.2.3