From 17a33db3995730ca6fb293ec7fd85cfcb0e2ee10 Mon Sep 17 00:00:00 2001
From: Lars Knoll <lars.knoll@digia.com>
Date: Thu, 29 Nov 2012 14:08:54 +0100
Subject: Fix Qt Xml docs and generate correct module and index pages

Change-Id: I95988798997edeb2d656d265e3172fa0d78db55a
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
---
 src/xml/doc/qtxml.qdocconf       |  2 +-
 src/xml/doc/src/qtxml-index.qdoc | 48 ++++++++++++++++++++++++++++++++++++++++
 src/xml/doc/src/qtxml.qdoc       |  4 ++--
 3 files changed, 51 insertions(+), 3 deletions(-)
 create mode 100644 src/xml/doc/src/qtxml-index.qdoc

(limited to 'src/xml')

diff --git a/src/xml/doc/qtxml.qdocconf b/src/xml/doc/qtxml.qdocconf
index f49950cf7f..33a514e3fc 100644
--- a/src/xml/doc/qtxml.qdocconf
+++ b/src/xml/doc/qtxml.qdocconf
@@ -27,7 +27,7 @@ qhp.QtXml.subprojects.classes.sortPages = true
 
 tagfile                 = ../../../doc/qtxml/qtxml.tags
 
-depends                 += qtcore qtnetwork qtdoc
+depends                 += qtcore qtnetwork
 
 headerdirs  += ..
 
diff --git a/src/xml/doc/src/qtxml-index.qdoc b/src/xml/doc/src/qtxml-index.qdoc
new file mode 100644
index 0000000000..692230d49e
--- /dev/null
+++ b/src/xml/doc/src/qtxml-index.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$
+**
+****************************************************************************/
+
+/*!
+    \page qtxml-index.html
+    \title Qt Xml
+    \brief The QtXml module provides C++ implementations of the SAX and DOM standards for XML.
+
+    The module is not actively maintained anymore. Please use
+    the QXmlStreamReader and QXmlStreamwriter classes in Qt Core instead.
+
+    To include the definitions of the module's classes, use the
+    following directive:
+
+    \snippet code/doc_src_qtxml.cpp 0
+
+    To link against the module, add this line to your \l qmake \c
+    .pro file:
+
+    \snippet code/doc_src_qtxml.pro 1
+
+    The \l{Qt Xml C++ classes} page gives an overview over the available classes
+    int this module.
+*/
diff --git a/src/xml/doc/src/qtxml.qdoc b/src/xml/doc/src/qtxml.qdoc
index 18b4a1fbbe..882bc38e1a 100644
--- a/src/xml/doc/src/qtxml.qdoc
+++ b/src/xml/doc/src/qtxml.qdoc
@@ -27,14 +27,14 @@
 
 /*!
     \module QtXml
-    \title QtXml Module
+    \title Qt Xml C++ classes
     \ingroup modules
     \ingroup technology-apis
 
     \brief The QtXml module provides C++ implementations of the SAX and DOM standards for XML.
 
     The module is not actively maintained anymore. Please use
-    the QXmlStreamReader and QXmlStreamwriter classes in Qt Core instead.
+    the \l{QXmlStreamReader} and \l{QXmlStreamWriter} classes in \l{Qt Core} instead.
 
     To include the definitions of the module's classes, use the
     following directive:
-- 
cgit v1.2.3