1 /****************************************************************************
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
40 ****************************************************************************/
46 // This file is not part of the Qt API. It exists purely as an
47 // implementation detail. This header file may change from version to
48 // version without notice, or even be removed.
53 * @mainpage QtXmlPatterns -- an implementation of XML technologies
55 * - @ref Patternist_info
56 * - @ref Patternist_writingDoxygen
58 * @section Patternist_info Overview
60 * This is the internal developer documentation for QtXmlPatterns. Please refer
61 * to Qt Assistant for usage documentation.
63 * The documentation that you are reading right now, can be generated by
64 * running <tt>doxygen</tt> in this directory without arguments. The generated
65 * documentation can subsequently be browsed from
66 * <tt>internal-docs/html/index.html</tt>.
68 * @subsection Patternist_writingDoxygen Doxygen Conventions
70 * Doxygen conventions, are as follows.
72 * - <tt>@@returns</tt> and <tt>@@param</tt> paragraphs are terminated with a period.
73 * - When XPath or XQuery expressions/queries appears in the Doxygen comments, wrap them
74 * in the @c tt HTML tag.
75 * - Classes and free standing functions should have an <tt>@@author</tt> tag, specifying who
76 * is the main author of it.
77 * - No code examples should appear directly in the Doxygen comments, they should be included with
78 * <tt>@@include</tt> or <tt>@@dontinclude</tt>.
79 * - The following terms are marked with <tt>@@c</tt> or the @c tt HTML tag:
81 * - @c true and @c false, when referred to as boolean values
82 * - All QNames and item types. For example, <tt>item\()</tt> and <tt>xs:string</tt>. Remember
83 * to use the @c tt HTML tag in these cases in order to include non-trivial characters
86 * - @c stderr, @c stdout, and @c stdin
89 * The current Doxygen comments does in some cases not adhere to this, but the
90 * idea is to harmonize in that direction over time.
92 * PatternistSDK, located in the test sources, is documented in the
93 * PatternistSDK Doxygen module.
95 * @author Frans Englich <frans.englich@nokia.com>