| 1 | /****************************************************************************
|
|---|
| 2 | **
|
|---|
| 3 | ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|---|
| 4 | ** Contact: Qt Software Information ([email protected])
|
|---|
| 5 | **
|
|---|
| 6 | ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
|
|---|
| 7 | **
|
|---|
| 8 | ** $QT_BEGIN_LICENSE:LGPL$
|
|---|
| 9 | ** Commercial Usage
|
|---|
| 10 | ** Licensees holding valid Qt Commercial licenses may use this file in
|
|---|
| 11 | ** accordance with the Qt Commercial License Agreement provided with the
|
|---|
| 12 | ** Software or, alternatively, in accordance with the terms contained in
|
|---|
| 13 | ** a written agreement between you and Nokia.
|
|---|
| 14 | **
|
|---|
| 15 | ** GNU Lesser General Public License Usage
|
|---|
| 16 | ** Alternatively, this file may be used under the terms of the GNU Lesser
|
|---|
| 17 | ** General Public License version 2.1 as published by the Free Software
|
|---|
| 18 | ** Foundation and appearing in the file LICENSE.LGPL included in the
|
|---|
| 19 | ** packaging of this file. Please review the following information to
|
|---|
| 20 | ** ensure the GNU Lesser General Public License version 2.1 requirements
|
|---|
| 21 | ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
|---|
| 22 | **
|
|---|
| 23 | ** In addition, as a special exception, Nokia gives you certain
|
|---|
| 24 | ** additional rights. These rights are described in the Nokia Qt LGPL
|
|---|
| 25 | ** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
|
|---|
| 26 | ** package.
|
|---|
| 27 | **
|
|---|
| 28 | ** GNU General Public License Usage
|
|---|
| 29 | ** Alternatively, this file may be used under the terms of the GNU
|
|---|
| 30 | ** General Public License version 3.0 as published by the Free Software
|
|---|
| 31 | ** Foundation and appearing in the file LICENSE.GPL included in the
|
|---|
| 32 | ** packaging of this file. Please review the following information to
|
|---|
| 33 | ** ensure the GNU General Public License version 3.0 requirements will be
|
|---|
| 34 | ** met: http://www.gnu.org/copyleft/gpl.html.
|
|---|
| 35 | **
|
|---|
| 36 | ** If you are unsure which license is appropriate for your use, please
|
|---|
| 37 | ** contact the sales department at [email protected].
|
|---|
| 38 | ** $QT_END_LICENSE$
|
|---|
| 39 | **
|
|---|
| 40 | ****************************************************************************/
|
|---|
| 41 |
|
|---|
| 42 | //
|
|---|
| 43 | // W A R N I N G
|
|---|
| 44 | // -------------
|
|---|
| 45 | //
|
|---|
| 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.
|
|---|
| 49 | //
|
|---|
| 50 | // We mean it.
|
|---|
| 51 |
|
|---|
| 52 | /**
|
|---|
| 53 | * @mainpage QtXmlPatterns -- an implementation of XML technologies
|
|---|
| 54 | *
|
|---|
| 55 | * - @ref Patternist_info
|
|---|
| 56 | * - @ref Patternist_writingDoxygen
|
|---|
| 57 | *
|
|---|
| 58 | * @section Patternist_info Overview
|
|---|
| 59 | *
|
|---|
| 60 | * This is the internal developer documentation for QtXmlPatterns. Please refer
|
|---|
| 61 | * to Qt Assistant for usage documentation.
|
|---|
| 62 | *
|
|---|
| 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>.
|
|---|
| 67 | *
|
|---|
| 68 | * @subsection Patternist_writingDoxygen Doxygen Conventions
|
|---|
| 69 | *
|
|---|
| 70 | * Doxygen conventions, are as follows.
|
|---|
| 71 | *
|
|---|
| 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:
|
|---|
| 80 | * - @c NaN
|
|---|
| 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
|
|---|
| 84 | * such as paranteses
|
|---|
| 85 | * - @c null
|
|---|
| 86 | * - @c stderr, @c stdout, and @c stdin
|
|---|
| 87 | *
|
|---|
| 88 | *
|
|---|
| 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.
|
|---|
| 91 | *
|
|---|
| 92 | * PatternistSDK, located in the test sources, is documented in the
|
|---|
| 93 | * PatternistSDK Doxygen module.
|
|---|
| 94 | *
|
|---|
| 95 | * @author Frans Englich <[email protected]>
|
|---|
| 96 | */
|
|---|
