diff options
Diffstat (limited to 'src/xmlpatterns')
-rw-r--r-- | src/xmlpatterns/api/qxmlschema.cpp | 2 | ||||
-rw-r--r-- | src/xmlpatterns/api/qxmlschemavalidator.cpp | 2 | ||||
-rw-r--r-- | src/xmlpatterns/doc/qtxmlpatterns.qdocconf | 36 | ||||
-rw-r--r-- | src/xmlpatterns/doc/src/qtxmlpatterns-examples.qdoc | 34 | ||||
-rw-r--r-- | src/xmlpatterns/doc/src/qtxmlpatterns-index.qdoc | 8 |
5 files changed, 55 insertions, 27 deletions
diff --git a/src/xmlpatterns/api/qxmlschema.cpp b/src/xmlpatterns/api/qxmlschema.cpp index a050a80..62dc3d1 100644 --- a/src/xmlpatterns/api/qxmlschema.cpp +++ b/src/xmlpatterns/api/qxmlschema.cpp @@ -63,7 +63,7 @@ QT_BEGIN_NAMESPACE This class is used to represent schemas that conform to the \l{XML Schema} 1.0 specification. - \sa QXmlSchemaValidator, {xmlpatterns/schema}{XML Schema Validation Example} + \sa QXmlSchemaValidator, {schema}{XML Schema Validation Example} */ /*! diff --git a/src/xmlpatterns/api/qxmlschemavalidator.cpp b/src/xmlpatterns/api/qxmlschemavalidator.cpp index da0ed3a..3783520 100644 --- a/src/xmlpatterns/api/qxmlschemavalidator.cpp +++ b/src/xmlpatterns/api/qxmlschemavalidator.cpp @@ -69,7 +69,7 @@ QT_BEGIN_NAMESPACE This class implements schema validation according to the \l{XML Schema} 1.0 specification. - \sa QXmlSchema, {xmlpatterns/schema}{XML Schema Validation Example} + \sa QXmlSchema, {schema}{XML Schema Validation Example} */ /*! diff --git a/src/xmlpatterns/doc/qtxmlpatterns.qdocconf b/src/xmlpatterns/doc/qtxmlpatterns.qdocconf index dc0a265..4ff60e5 100644 --- a/src/xmlpatterns/doc/qtxmlpatterns.qdocconf +++ b/src/xmlpatterns/doc/qtxmlpatterns.qdocconf @@ -1,15 +1,13 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) -# Name of the project which must match the outputdir. Determines the .index file project = QtXmlPatterns +description = Qt XML Patterns Reference Documentation +version = $QT_VERSION -# Directories in which to search for files to document and images. -# By default set to the root directory of the project for sources -# and headers and qdoc will therefore generate output for each file. -# Images should be placed in <rootdir>/dic/images and examples in -# <rootdir>/examples. -# Paths are relative to the location of this file. -exampledirs += ../../../examples \ +examplesinstallpath = xmlpatterns + +exampledirs += ../../../examples/xmlpatterns \ + ../ \ snippets headerdirs += .. @@ -18,33 +16,23 @@ sourcedirs += .. depends += qtcore qtxml qtwidgets qtdesigner qtdoc -# The following parameters are for creating a qhp file, the qhelpgenerator -# program can convert the qhp file into a qch file which can be opened in -# Qt Assistant and/or Qt Creator. - -# Defines the name of the project. You cannot use operators (+, =, -) in -# the name. Properties for this project are set using a qhp.<projectname>.property -# format. qhp.projects = QtXmlPatterns -# Sets the name of the output qhp file. qhp.QtXmlPatterns.file = qtxmlpatterns.qhp - -# Namespace for the output file. This namespace is used to distinguish between -# different documentation files in Creator/Assistant. qhp.QtXmlPatterns.namespace = org.qt-project.qtxmlpatterns.$QT_VERSION_TAG - -# Title for the package, will be the main title for the package in -# Assistant/Creator. qhp.QtXmlPatterns.indexTitle = Qt XML Patterns - -# Only update the name of the project for the next variables. qhp.QtXmlPatterns.virtualFolder = qtxmlpatterns + qhp.QtXmlPatterns.subprojects = classes qhp.QtXmlPatterns.subprojects.classes.title = C++ Classes qhp.QtXmlPatterns.subprojects.classes.indexTitle = Qt XML Patterns C++ Classes qhp.QtXmlPatterns.subprojects.classes.selectors = class fake:headerfile qhp.QtXmlPatterns.subprojects.classes.sortPages = true +tagfile = ../../../doc/qtxmlpatterns/qtxmlpatterns.tags + +# Use a generic thumbnail image for examples that have no images in their docs +manifestmeta.thumbnail.names += "QtXmlPatterns/C++ Source Code Analyzer Example" + navigation.landingpage = "Qt XML Patterns" navigation.cppclassespage = "Qt XML Patterns C++ Classes" 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. |