summaryrefslogtreecommitdiffstats
path: root/doc/src/classes.qdoc
diff options
context:
space:
mode:
authorMartin Smith <msmith@trolltech.com>2009-08-21 11:07:45 (GMT)
committerMartin Smith <msmith@trolltech.com>2009-08-21 11:08:32 (GMT)
commit500ee5b8888eed68f3d237c498c56ef0ebb9795e (patch)
treeae600bf93a49b8b43c36a44eba00d4178eeb9031 /doc/src/classes.qdoc
parentbb49724be3439311c539a7f5bb0014c5fd83f375 (diff)
downloadQt-500ee5b8888eed68f3d237c498c56ef0ebb9795e.zip
Qt-500ee5b8888eed68f3d237c498c56ef0ebb9795e.tar.gz
Qt-500ee5b8888eed68f3d237c498c56ef0ebb9795e.tar.bz2
qdoc: Redesigned the Class and Function Documentation page.
Diffstat (limited to 'doc/src/classes.qdoc')
-rw-r--r--doc/src/classes.qdoc123
1 files changed, 72 insertions, 51 deletions
diff --git a/doc/src/classes.qdoc b/doc/src/classes.qdoc
index 864445f..24acce1 100644
--- a/doc/src/classes.qdoc
+++ b/doc/src/classes.qdoc
@@ -41,58 +41,85 @@
/*!
\group classlists
- \title Class and Function Indexes
- \brief Collections of classes and functions grouped together into lists.
+ \title Class and Function Documentation
+ \brief Lists and Indexes of classes, functions, and types.
- The following documents contain collections of classes, grouped by
- subject area or related to particular functionality, or comprehensive
- lists of classes and functions.
+ Links to indexes and lists for finding class and function
+ reference documentation.
+
+ \section2 Class Lists
+
+ \annotatedlist classlists
+
+ \section2 Function Lists
+
+ \annotatedlist funclists
- \generatelist{related}
*/
/*!
- \group groups
- \title Grouped Classes
+ \page classes.html
+ \title All Qt Classes (main index)
\ingroup classlists
- This page provides a way of navigating Qt's classes by grouping
- related classes together. Some classes may appear in more than one group.
+ \brief If you know the name of the class you want, find it here.
- \generatelist{related}
+ This is a list of all Qt classes. For a list of the classes
+ provided for compatibility with Qt3, see \l{Qt3 Support
+ Classes}. For classes that have been deprecated, see the
+ \l{Obsolete Classes} list.
+
+ \generatelist classes
+ \sa {Qt3 Support Classes}, {All Qt Modules}, {Obsolete Classes}
*/
/*!
- \page classes.html
- \title Qt's Classes
+ \page annotated.html
+ \title Annotated Class List
\ingroup classlists
- This is a list of all Qt classes. For a list of the classes provided
- for compatibility with Qt3, see \l{Qt 3 compatibility classes}. For
- classes that have been deprecated, see the \l{Obsolete Classes} list.
+ \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.
- \generatelist classes
+ Qt classes with brief descriptions:
- \sa {Qt 3 Compatibility Classes}, {Qt's Modules}, {Obsolete Classes}
+ \generatelist annotatedclasses
*/
/*!
- \page namespaces.html
- \title Qt's Namespaces
+ \group groups
+ \title Groups Of Related Classes
\ingroup classlists
- This is a list of the main namespaces in Qt. For a list of classes in
- Qt, see \l{Qt's Classes}.
+ \brief If you know what kind of class you want (GUI, painting,
+ I.O, etc), look here.
- \generatelist{namespaces}
+ 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 These classes are obsolete and should not be used in new code.
This is a list of Qt classes that are obsolete (deprecated). These
classes are provided to keep old source code working but they are
@@ -101,52 +128,46 @@
\generatelist obsoleteclasses
- \sa {Qt's Classes}, {Qt's Modules}
*/
/*!
- \page annotated.html
- \title Annotated Class Index
+ \page compatclasses.html
+ \title Qt3 Support Classes
\ingroup classlists
- Qt's classes with brief descriptions:
+ \brief These classes ease the porting of code from Qt 3 to Qt 4.
- \generatelist annotatedclasses
-*/
-
-/*!
- \page functions.html
- \title Member Function Index
- \ingroup classlists
+ These are the classes that Qt provides for compatibility with Qt
+ 3. Most of these are provided by the Qt3Support module.
- Here is the list of all the documented member functions in the Qt
- API with links to the class documentation for each function.
+ \generatelist compatclasses
- \generatelist functionindex
*/
/*!
- \page hierarchy.html
+ \page functions.html
+ \title All Functions (main index)
+ \ingroup funclists
- \title Class Inheritance Hierarchy
- \ingroup classlists
+ \brief All documented Qt functions listed alphabetically with a
+ link to where each one is declared.
- This list shows the C++ class inheritance relations between the
- classes in the Qt API.
+ 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.
- \generatelist classhierarchy
+ \generatelist functionindex
*/
+
/*!
- \page compatclasses.html
- \title Qt 3 Compatibility Classes
+ \page namespaces.html
+ \title All Qt Namespaces
\ingroup classlists
- This is a list of the classes that Qt provides for compatibility
- with Qt 3. The vast majority of these are provided by the
- Qt3Support module.
+ \brief A Qt namespace contains enum types, functions, and sometimes classes.
- \generatelist compatclasses
+ This is a list of the main namespaces in Qt.
- \sa {Qt's Classes}, {Qt's Modules}
+ \generatelist{namespaces}
*/