From d9bad12fc8bba20a147b20b6923218aa00863ae5 Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Fri, 6 Dec 2013 13:22:10 +0100 Subject: Doc: solved link problem for dombookmarks.qdoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Task-number: QTBUG-34749 Change-Id: I2f2fbf16314e069ab04e5c5ab4bcef9780c008a2 Reviewed-by: Venugopal Shivashankar Reviewed-by: Topi Reiniö --- examples/xml/doc/images/dombookmarks-example.png | Bin 0 -> 19405 bytes examples/xml/doc/src/dombookmarks.qdoc | 40 +++++++++++++++++++++++ 2 files changed, 40 insertions(+) create mode 100644 examples/xml/doc/images/dombookmarks-example.png create mode 100644 examples/xml/doc/src/dombookmarks.qdoc (limited to 'examples') diff --git a/examples/xml/doc/images/dombookmarks-example.png b/examples/xml/doc/images/dombookmarks-example.png new file mode 100644 index 0000000000..abacacbbfc Binary files /dev/null and b/examples/xml/doc/images/dombookmarks-example.png differ diff --git a/examples/xml/doc/src/dombookmarks.qdoc b/examples/xml/doc/src/dombookmarks.qdoc new file mode 100644 index 0000000000..a30f66d94e --- /dev/null +++ b/examples/xml/doc/src/dombookmarks.qdoc @@ -0,0 +1,40 @@ +/**************************************************************************** +** +** 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 dombookmarks + \title DOM Bookmarks Example + + 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 + example provides an alternative way to read this type of file. + + \image dombookmarks-example.png + + See the \l{http://pyxml.sourceforge.net/topics/xbel/}{XML Bookmark Exchange Language + Resource Page} for more information about XBEL files. +*/ -- cgit v1.2.3 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ö --- examples/xml/doc/images/dombookmarks-example.png | Bin 19405 -> 0 bytes examples/xml/doc/src/dombookmarks.qdoc | 40 ----------- .../doc/images/dombookmarks-example.png | Bin 0 -> 19405 bytes .../xml/dombookmarks/doc/src/dombookmarks.qdoc | 41 ++++++++++++ .../xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc | 73 +++++++++++++++++++++ 5 files changed, 114 insertions(+), 40 deletions(-) delete mode 100644 examples/xml/doc/images/dombookmarks-example.png delete mode 100644 examples/xml/doc/src/dombookmarks.qdoc create mode 100644 examples/xml/dombookmarks/doc/images/dombookmarks-example.png create mode 100644 examples/xml/dombookmarks/doc/src/dombookmarks.qdoc create mode 100644 examples/xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc (limited to 'examples') diff --git a/examples/xml/doc/images/dombookmarks-example.png b/examples/xml/doc/images/dombookmarks-example.png deleted file mode 100644 index abacacbbfc..0000000000 Binary files a/examples/xml/doc/images/dombookmarks-example.png and /dev/null differ diff --git a/examples/xml/doc/src/dombookmarks.qdoc b/examples/xml/doc/src/dombookmarks.qdoc deleted file mode 100644 index a30f66d94e..0000000000 --- a/examples/xml/doc/src/dombookmarks.qdoc +++ /dev/null @@ -1,40 +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 dombookmarks - \title DOM Bookmarks Example - - 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 - example provides an alternative way to read this type of file. - - \image dombookmarks-example.png - - See the \l{http://pyxml.sourceforge.net/topics/xbel/}{XML Bookmark Exchange Language - Resource Page} for more information about XBEL files. -*/ diff --git a/examples/xml/dombookmarks/doc/images/dombookmarks-example.png b/examples/xml/dombookmarks/doc/images/dombookmarks-example.png new file mode 100644 index 0000000000..abacacbbfc Binary files /dev/null and b/examples/xml/dombookmarks/doc/images/dombookmarks-example.png differ diff --git a/examples/xml/dombookmarks/doc/src/dombookmarks.qdoc b/examples/xml/dombookmarks/doc/src/dombookmarks.qdoc new file mode 100644 index 0000000000..f74856eb2c --- /dev/null +++ b/examples/xml/dombookmarks/doc/src/dombookmarks.qdoc @@ -0,0 +1,41 @@ +/**************************************************************************** +** +** 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 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 + example provides an alternative way to read this type of file. + + \image dombookmarks-example.png + + See the \l{http://pyxml.sourceforge.net/topics/xbel/}{XML Bookmark Exchange Language + Resource Page} for more information about XBEL files. +*/ diff --git a/examples/xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc b/examples/xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc new file mode 100644 index 0000000000..376f074555 --- /dev/null +++ b/examples/xml/xmlstreamlint/doc/src/xmlstreamlint.qdoc @@ -0,0 +1,73 @@ +/**************************************************************************** +** +** 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 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 + 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. +*/ -- cgit v1.2.3 From ac90b4c46f11ec08a9f4eebf909f9c66f10e4288 Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Wed, 11 Dec 2013 10:50:16 +0100 Subject: Doc: corrected broken links MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Task-number: QTBUG-34749 Corrected link to drag and drop example. Corrected link to {mandatory fields} Created target referring to macros for defining plugins Change-Id: I387a2d9bab428b2eacd8d371f08c72f42f7e2be2 Reviewed-by: Topi Reiniö --- examples/widgets/doc/src/classwizard.qdoc | 2 +- examples/widgets/doc/src/echoplugin.qdoc | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'examples') diff --git a/examples/widgets/doc/src/classwizard.qdoc b/examples/widgets/doc/src/classwizard.qdoc index 5a88076155..cc2c61f126 100644 --- a/examples/widgets/doc/src/classwizard.qdoc +++ b/examples/widgets/doc/src/classwizard.qdoc @@ -156,7 +156,7 @@ Then we create the child widgets, create \l{Registering and Using Fields}{wizard fields} associated with them, and put them into layouts. The \c className field is created with an asterisk (\c - *) next to its name. This makes it a \l{mandatory field}, that + *) next to its name. This makes it a \l{mandatory fields}{mandatory field}, that is, a field that must be filled before the user can press the \uicontrol Next button (\uicontrol Continue on Mac OS X). The fields' values can be accessed from any other page using QWizardPage::field(), diff --git a/examples/widgets/doc/src/echoplugin.qdoc b/examples/widgets/doc/src/echoplugin.qdoc index 9e2b0c35de..103a51cf93 100644 --- a/examples/widgets/doc/src/echoplugin.qdoc +++ b/examples/widgets/doc/src/echoplugin.qdoc @@ -194,10 +194,10 @@ \section1 Further reading and examples - You can find an overview of the macros needed to create plugins - \l{Macros for Defining Plugins}{here}. + The \l {qtplugin-defining-plugins}{Defining Plugins} page presents an overview of the macros needed to + create plugins. - We give an example of a plugin that extend Qt in the \l{Style + We give an example of a plugin that extends Qt in the \l{Style Plugin Example}{style plugin} example. The \l{Plug & Paint Example}{plug and paint} example shows how to create static plugins. -- cgit v1.2.3