diff options
| author | Øystein Heskestad <oystein.heskestad@qt.io> | 2023-03-01 14:23:45 +0100 |
|---|---|---|
| committer | Øystein Heskestad <oystein.heskestad@qt.io> | 2023-03-02 12:20:18 +0100 |
| commit | e13b57d06ab6e81cf04c090cc46dd23b4f8daccf (patch) | |
| tree | 2964cabd09607f6b8d0c62d55f791f4ba73963fc /examples/xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc | |
| parent | 56b3123689be7c408d9b6c8c48648a15f0e46658 (diff) | |
Move xmlstreamlint example into tests/manual
This example is useful but not a typical starting point for an
application.
Task-number: QTBUG-110647
Pick-to: 6.5
Change-Id: Ic4af8ed648c587b91110a7403fa80c619549289d
Reviewed-by: Marc Mutz <marc.mutz@qt.io>
Diffstat (limited to 'examples/xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc')
| -rw-r--r-- | examples/xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc | 51 |
1 files changed, 0 insertions, 51 deletions
diff --git a/examples/xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc b/examples/xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc deleted file mode 100644 index 870203c584e..00000000000 --- a/examples/xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc +++ /dev/null @@ -1,51 +0,0 @@ -// Copyright (C) 2016 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only - -/*! - \example xmlstreamlint - \title XML Stream Lint Example - \ingroup xml-examples - \brief A commandline tool reading from an input file and writing to - the standard output file. - - 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. -*/ |