AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix Qt Xml docs and generate correct module and index pages

Browse Source 
Change-Id: I95988798997edeb2d656d265e3172fa0d78db55a
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
This commit is contained in:
Lars Knoll 2012-11-29 14:08:54 +01:00 committed by The Qt Project
parent c85ca8d1cf
commit 17a33db399
3 changed files with 51 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/xml/doc/qtxml.qdocconf
View File

@ -27,7 +27,7 @@ qhp.QtXml.subprojects.classes.sortPages = true
tagfile = ../../../doc/qtxml/qtxml.tags tagfile = ../../../doc/qtxml/qtxml.tags
depends += qtcore qtnetwork qtdoc depends += qtcore qtnetwork
headerdirs += .. headerdirs += ..

48
src/xml/doc/src/qtxml-index.qdoc Normal file
View File

@ -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.
*/

4
src/xml/doc/src/qtxml.qdoc
View File

@ -27,14 +27,14 @@
/*! /*!
\module QtXml \module QtXml
\title QtXml Module \title Qt Xml C++ classes
\ingroup modules \ingroup modules
\ingroup technology-apis \ingroup technology-apis
\brief The QtXml module provides C++ implementations of the SAX and DOM standards for 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 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 To include the definitions of the module's classes, use the
following directive: following directive: