-
Martin Smith authored
qdoc has been modified to emit a compact list of the classes that have one or more obsolete members. The command is: \generatelist obsoletecppmembers This generates an index of all such classes, where each class name is a link to the class's subpage of obsolete members. A class's subpage of obsolete members is also accessible from the class's reference page, but now it is also accessible from this index. Also, The command shown has been added to the page obsoleteclasses.html in the generated output. This page already contains the index of obsolete classes. Currently, no such output is generated for QML types and QML types with obsolete members. But qdoc does accept commands for those: \generatelist obsoleteqmltypes and \generatelist obsoleteqmlmembers ...but qdoc doesn't know what to do with those commands yet. Task-number: QTBUG-30270 Change-Id: Ia5cd309a3593c231d01cafb8a72fa544aeeb5ab9 Reviewed-by:Jerome Pasion <jerome.pasion@digia.com>
02157fad
/******************************************************************************** Copyright (C) 2013 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$******************************************************************************//*! \group classlists \title Class and Function Documentation \brief Lists and Indexes of classes, functions, and types. Links to indexes and lists for finding class and function reference documentation. \section2 Class Lists \annotatedlist classlists \section2 Function Lists \annotatedlist funclists*//*! \page classes.html \title All Classes \ingroup classlists \brief If you know the name of the class you want, find it here. This is a list of all Qt classes. For classes that have been deprecated, see the \l{Obsolete Classes} list. \generatelist classes \sa {All Modules}, {Obsolete Classes}*//*! \page annotated.html \title Annotated Class List \ingroup classlists \brief If you don't know the name of the class you want, but you know what the class should do, you might try looking here. Qt classes with brief descriptions:7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
\generatelist annotatedclasses
*/
/*!
\group groups
\title Groups Of Related Classes
\ingroup classlists
\brief If you know what kind of class you want (GUI, painting,
I.O, etc), look here.
This is a list of functional groups of Qt classes. A class can
appear in more than one functional group.
\generatelist{related}
*/
/*!
\page hierarchy.html
\title Inheritance Hierarchy
\ingroup classlists
\brief The C++ class inheritance hierarchy for all classes in the
Qt API.
\generatelist classhierarchy
*/
/*!
\page obsoleteclasses.html
\title Obsolete Classes
\ingroup classlists
\brief Classes and members marked obsolete that should not be used in new code.
\section1 C++ classes that are deprecated
The following Qt C++ classes are now obsolete. Obsolete classes
are no longer maintained. They are provided to keep old source
code working, but they can be removed in a future release. We
strongly advise against using these classes in new code.
\generatelist obsoleteclasses
\section1 C++ classes that contain one or more members that are deprecated
The following Qt C++ classes contain one or more members that are
now obsolete. Obsolete members are no longer maintained. They are
provided to keep old source code working, but they can be removed
in a future release. We strongly advise against using these obsolete
members in new code. Click on a class to see its deprecated members.
\generatelist obsoletecppmembers
*/
/*!
\page functions.html
\title All Functions
\ingroup funclists
\brief All documented Qt functions listed alphabetically with a
link to where each one is declared.
This is the list of all documented member functions and global
functions in the Qt API. Each function has a link to the class or
header file where it is declared and documented.
141142143144145146147148149150151152153154155156
\generatelist functionindex
*/
/*!
\page namespaces.html
\title All Namespaces
\ingroup classlists
\brief A Qt namespace contains enum types, functions, and sometimes classes.
This is a list of the main namespaces in Qt.
\generatelist{namespaces}
*/