1/****************************************************************************
2**
3** Copyright (C) 2015 The Qt Company Ltd.
4** Contact: http://www.qt.io/licensing/
5**
6** This file is part of the documentation of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:FDL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see http://www.qt.io/terms-conditions. For further
15** information use the contact form at http://www.qt.io/contact-us.
16**
17** GNU Free Documentation License Usage
18** Alternatively, this file may be used under the terms of the GNU Free
19** Documentation License version 1.3 as published by the Free Software
20** Foundation and appearing in the file included in the packaging of
21** this file.  Please review the following information to ensure
22** the GNU Free Documentation License version 1.3 requirements
23** will be met: http://www.gnu.org/copyleft/fdl.html.
24** $QT_END_LICENSE$
25**
26****************************************************************************/
27
28/*!
29    \group classlists
30    \title Class and Function Documentation
31    \brief Lists and Indexes of classes, functions, and types.
32
33    Links to indexes and lists for finding class and function
34    reference documentation.
35
36    \section2 Class Lists
37
38    \annotatedlist classlists
39
40    \section2 Function Lists
41
42    \annotatedlist funclists
43
44*/
45
46/*!
47    \page classes.html
48    \title All Classes
49    \ingroup classlists
50
51    \brief If you know the name of the class you want, find it here.
52
53    This is a list of all Qt classes. For a list of the classes
54    provided for compatibility with Qt3, see \l{Qt3 Support
55    Classes}. For classes that have been deprecated, see the
56    \l{Obsolete Classes} list.
57
58    \generatelist classes
59
60    \sa {Qt3 Support Classes}, {All Modules}, {Obsolete Classes}
61*/
62
63/*!
64    \page annotated.html
65    \title Annotated Class List
66    \ingroup classlists
67
68    \brief If you don't know the name of the class you want, but you
69    know what the class should do, you might try looking here.
70
71    Qt classes with brief descriptions:
72
73    \generatelist annotatedclasses
74*/
75
76/*!
77    \group groups
78    \title Groups Of Related Classes
79    \ingroup classlists
80
81    \brief If you know what kind of class you want (GUI, painting,
82    I.O, etc), look here.
83
84    This is a list of functional groups of Qt classes. A class can
85    appear in more than one functional group.
86
87    \generatelist{related}
88
89*/
90
91/*!
92    \page hierarchy.html
93
94    \title Inheritance Hierarchy
95    \ingroup classlists
96
97    \brief The C++ class inheritance hierarchy for all classes in the
98    Qt API.
99
100    \generatelist classhierarchy
101*/
102
103/*!
104    \page obsoleteclasses.html
105    \title Obsolete Classes
106    \ingroup classlists
107
108    \brief These classes are obsolete and should not be used in new code.
109
110    This is a list of Qt classes that are obsolete (deprecated). These
111    classes are provided to keep old source code working but they are
112    no longer maintained. We strongly advise against using these
113    classes in new code.
114
115    \generatelist obsoleteclasses
116
117*/
118
119/*!
120    \page compatclasses.html
121    \title Qt3 Support Classes
122    \ingroup classlists
123
124    \brief These classes ease the porting of code from Qt 3 to Qt 4.
125
126    These are the classes that Qt provides for compatibility with Qt
127    3. Most of these are provided by the Qt3Support module.
128
129    \generatelist compatclasses
130
131*/
132
133/*!
134    \page functions.html
135    \title All Functions
136    \ingroup funclists
137
138    \brief All documented Qt functions listed alphabetically with a
139    link to where each one is declared.
140
141    This is the list of all documented member functions and global
142    functions in the Qt API.  Each function has a link to the class or
143    header file where it is declared and documented.
144
145    \generatelist functionindex
146*/
147
148
149/*!
150    \page namespaces.html
151    \title All Namespaces
152    \ingroup classlists
153
154    \brief A Qt namespace contains enum types, functions, and sometimes classes.
155
156    This is a list of the main namespaces in Qt.
157
158    \generatelist{namespaces}
159*/
160