src/xmlpatterns/Mainpage.dox

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  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 <frans.englich@nokia.com>
  96  */