summaryrefslogtreecommitdiff
path: root/src/xmlpatterns/doc/src/qtxmlpatterns-module.qdoc
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2012-11-22 16:35:24 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2012-11-23 13:16:20 +0100
commit051aeb291646745559c47da160193bdcbd34ef2b (patch)
tree50040152b4dfe22238ef0446c9e57ff1b345bdd4 /src/xmlpatterns/doc/src/qtxmlpatterns-module.qdoc
parentb34af22fcc7e9321e5a7943763cd68a1d51a36d5 (diff)
downloadqtxmlpatterns-051aeb291646745559c47da160193bdcbd34ef2b.tar.gz
Doc: Modularized Qt XML Patterns documentation.
-moved snippets, images, documentation to src/xmlpatterns -fixed \snippet tag -ported module information from qtdoc repository -enabled "make docs" for the module -set up qdocconf file and .index file -updated tests/auto/patternistexamples to point to the new snippet locations Change-Id: Ifd10733c277c6dbacac42898c8e7bacd00d23f27 Reviewed-by: Lars Knoll <lars.knoll@digia.com>
Diffstat (limited to 'src/xmlpatterns/doc/src/qtxmlpatterns-module.qdoc')
-rw-r--r--src/xmlpatterns/doc/src/qtxmlpatterns-module.qdoc48
1 files changed, 48 insertions, 0 deletions
diff --git a/src/xmlpatterns/doc/src/qtxmlpatterns-module.qdoc b/src/xmlpatterns/doc/src/qtxmlpatterns-module.qdoc
new file mode 100644
index 0000000..c88b28a
--- /dev/null
+++ b/src/xmlpatterns/doc/src/qtxmlpatterns-module.qdoc
@@ -0,0 +1,48 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 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$
+**
+****************************************************************************/
+/*!
+ \module QtXmlPatterns
+ \title Qt XML Patterns C++ Classes
+ \brief The Qt XML Patterns module provides support for XPath,
+ XQuery, XSLT and XML Schema validation.
+
+ \ingroup modules
+ \ingroup technology-apis
+
+The \l{Qt XML Patterns} module provides support for XPath,
+ XQuery, XSLT and XML Schema validation.
+
+ To include the definitions of the module's classes, use the
+ following directive:
+
+ \snippet doc_src_qtxmlpatterns.cpp 0
+
+ To link against the module, add this line to your \l qmake \c
+ .pro file:
+
+ \snippet doc_src_qtxmlpatterns.pro 1
+*/