diff options
| author | MattV <qt-info@nokia.com> | 2009-03-05 16:59:50 +1000 |
|---|---|---|
| committer | MattV <qt-info@nokia.com> | 2009-03-05 16:59:50 +1000 |
| commit | e672444411894e1731b91cf82e7dd9232e94a7af (patch) | |
| tree | ece4dc62614ac222317ff28a8d3e5fb30fdaf426 /doc/src/api | |
| parent | 7fb9bd8a4e5d5c31e40f2480edf2b367800fe3a8 (diff) | |
Make the generated documentation resemble the Qtopia Messaging module documentation.
Diffstat (limited to 'doc/src/api')
| -rw-r--r-- | doc/src/api/api-pages.qdoc | 54 | ||||
| -rw-r--r-- | doc/src/api/classhierarchy.qdoc | 13 | ||||
| -rw-r--r-- | doc/src/api/groups.qdoc | 75 |
3 files changed, 142 insertions, 0 deletions
diff --git a/doc/src/api/api-pages.qdoc b/doc/src/api/api-pages.qdoc new file mode 100644 index 00000000..8e300713 --- /dev/null +++ b/doc/src/api/api-pages.qdoc @@ -0,0 +1,54 @@ + +/*! +\page classes.html +\target top +\title Class Index + +\generatelist classes + +*/ + +/*! + +\page namespaces.html +\title Qt Extended Namespaces +\ingroup classlists + +This is a list of the main namespaces in Qt Extended. For a list of classes in +Qt Extended, see \l{Class Index}. + +MergeQtGroupHere +\generatelist namespaces + +*/ + +/*! + +\page annotated.html +\target top +\title Annotated Class List + +\generatelist annotatedclasses + +*/ + + +/*! + +\page functions.html +\target top +\title Functions + +\generatelist functionindex + +*/ + +/*! + +\page qtextended-classes.html +\target top +\title Qt Extended Class List + +\generatelist mainclasses + +*/ diff --git a/doc/src/api/classhierarchy.qdoc b/doc/src/api/classhierarchy.qdoc new file mode 100644 index 00000000..69212ead --- /dev/null +++ b/doc/src/api/classhierarchy.qdoc @@ -0,0 +1,13 @@ +/*! +\page classeshierarchy.html +\target top +\title Messaging Framework Class Inheritance Hierarchy + +This list shows the C++ class inheritance relations between the +classes in the Messaging Framework API. + +The list is sorted alphabetically. + +\generatelist classhierarchy + +*/ diff --git a/doc/src/api/groups.qdoc b/doc/src/api/groups.qdoc new file mode 100644 index 00000000..7afb2e04 --- /dev/null +++ b/doc/src/api/groups.qdoc @@ -0,0 +1,75 @@ +/*! + \page groups.html + + \title Grouped Classes + + This page provides a way to navigate the Qt Extended classes by grouping + related classes together. Some classes may appear in more than one group. + + + \section1 UI Controls & Interaction + + \table 100% + \header + \o Group + \o Description + + \row + \o \l{Messaging Client Utility Classes} + \o Classes that provide GUI elements that assist with the development of messaging client applications. + + \endtable + + + + \section1 Media and Document Handling + + \table 100% + \header + \o Group + \o Description + + \row + \o \l{Messaging Classes} + \o Classes that provide support for manipulating messages. + + \row + \o \l{Message Server Support Classes} + \o Classes that assist with building components that provide services for the message server. + + \endtable + +*/ + +/*! + \group messaginglibrary + \title Messaging Classes + + These classes allow clients to work with mail messages, providing access to + message creation, storage and display functionality. + + Classes are also provided to assist with development of GUI clients that access + messaging data, via the \l{Messaging Client Utility Classes}{Client Utility Classes}, + and to assist with development of Message Server plugins via the + \l{Message Server Support Classes}{Server Support Classes}. + + \sa {Qt Extended Messaging Library} +*/ + +/*! + \group libmessageserver + \title Message Server Support Classes + + These classes provide assistance in developing GUI clients that access messaging data. + + \sa {Message Server Support Library}, {Qt Extended Messaging Library} +*/ + +/*! + \group qmfutil + \title Messaging Client Utility Classes + + These classes provide assistance in developing plugins for the \l{Message Server}{Message Server} daemon. + + \sa {Messaging Client Utility Library}, {Qt Extended Messaging Library} +*/ |