diff options
author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2014-10-17 15:55:53 +0200 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-01-05 16:59:36 +0100 |
commit | 060cc3c47062a35e8127413ece57573d1aca067f (patch) | |
tree | f470e22b330ae41026949b3491a1f5e241564139 /src/xmlpatterns/doc/src | |
parent | 64dcf54e06556f951dff277feb9a9b6aa7767cf8 (diff) | |
download | qtxmlpatterns-060cc3c47062a35e8127413ece57573d1aca067f.tar.gz |
- Add \brief commands to example docs to show descriptions
- Add an examples page with the \group command
- Link to the examples page from the module index page
- Edit the .qdocconf file
- Edit the .gitignore file to allow pushing changes to examples
- Add a generic thumbnail image for C++ Code Analyzer example
Change-Id: I1a313ae26664ce9fc50ef8962f0facd57dea546b
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/xmlpatterns/doc/src')
-rw-r--r-- | src/xmlpatterns/doc/src/qtxmlpatterns-examples.qdoc | 34 | ||||
-rw-r--r-- | src/xmlpatterns/doc/src/qtxmlpatterns-index.qdoc | 8 |
2 files changed, 41 insertions, 1 deletions
diff --git a/src/xmlpatterns/doc/src/qtxmlpatterns-examples.qdoc b/src/xmlpatterns/doc/src/qtxmlpatterns-examples.qdoc new file mode 100644 index 0000000..f0da710 --- /dev/null +++ b/src/xmlpatterns/doc/src/qtxmlpatterns-examples.qdoc @@ -0,0 +1,34 @@ +/**************************************************************************** +** +** Copyright (C) 2014 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$ +** +****************************************************************************/ +/*! + \group xmlpattern_examples + \title Qt XML Patterns Examples + \brief Examples in the Qt XML Patterns module. + \ingroup all-examples + + These are the examples available in the \l{Qt XML Patterns} module. +*/ diff --git a/src/xmlpatterns/doc/src/qtxmlpatterns-index.qdoc b/src/xmlpatterns/doc/src/qtxmlpatterns-index.qdoc index f9c6f16..a195767 100644 --- a/src/xmlpatterns/doc/src/qtxmlpatterns-index.qdoc +++ b/src/xmlpatterns/doc/src/qtxmlpatterns-index.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2014 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. @@ -52,6 +52,12 @@ \li \l{XQuery} - general overviews of XQuery and XSchema \endlist + \section1 Examples + + \list + \li \l{Qt XML Patterns Examples} + \endlist + \section1 API Reference These are links to the API reference materials. |