Mainpage.dox

   1 /**
   2         * @mainpage KDE PIM API Reference
   3         *
   4         *
   5         * \section Overview
   6         *
   7         * This section contains the KDE online class reference for the current
   8         * development version of KDE-PIM.  Additionally, you can subscribe
   9         * or read the mailing lists for any additions and/or modifications
  10         * to the API.
  11         *
  12         * <table width="100%">
  13         * <tr><th>Applications</th><th>Libraries</th></tr>
  14         * <tr><td valign="top">
  15         * - <a href="kaddressbook/html/index.html"><b>kaddressbook</b></a>
  16         *   (<a href="kaddressbook/html/classes.html">classes</a>)\n
  17         *   <i>Keeps your addresses on file.</i>
  18         * - <a href="akregator/html/index.html"><b>akregator</b></a>
  19         *   (<a href="akregator/html/classes.html">classes</a>)\n
  20         *   <i>Feed reader.</i>
  21         * - <a href="kalarm/html/index.html"><b>kalarm</b></a>
  22         *   (<a href="kalarm/html/classes.html">classes</a>)\n
  23         *   <i>A personal alarm message, command and email scheduler.</i>
  24         * - <a href="kalarm/kalarmd/html/index.html"><b>kalarmd</b></a>
  25         *   (<a href="kalarm/kalarmd/html/classes.html">classes</a>)\n
  26         *   <i>Alarm daemon.</i>
  27         * - <a href="kjots/html/index.html"><b>kjots</b></a>
  28         *   (<a href="kjots/html/classes.html">classes</a>)\n
  29         *   <i>A time tracker.</i>
  30         * - <a href="kleopatra/html/index.html"><b>kleopatra</b></a>
  31         *   (<a href="kleopatra/html/classes.html">classes</a>)\n
  32         *   <i>KDE Key Manager.</i>
  33         * - <a href="kmail/html/index.html"><b>kmail</b></a>
  34         *   (<a href="kmail/html/classes.html">classes</a>)\n
  35         *   <i>A fully-featured email client.</i>
  36         * - <a href="knode/html/index.html"><b>knode</b></a>
  37         *   (<a href="knode/html/classes.html">classes</a>)\n
  38         *   <i>The KDE news reader.</i>
  39         * - <a href="knotes/html/index.html"><b>knotes</b></a>
  40         *   (<a href="knotes/html/classes.html">classes</a>)\n
  41         *   <i>A small tool to scribble down notes.</i>
  42         * - <a href="konsolekalendar/html/index.html"><b>konsolekalendar</b></a>
  43         *   (<a href="konsolekalendar/html/classes.html">classes</a>)\n
  44         *   <i>A command line interface to KDE calendars.</i>
  45         * - <a href="kontact/html/index.html"><b>kontact</b></a>
  46         *   (<a href="kontact/html/classes.html">classes</a>)\n
  47         *   <i>Brings together all the KDE PIM applications under one roof.</i>
  48         * - <a href="korganizer/html/index.html"><b>korganizer</b></a>
  49         *   (<a href="korganizer/html/classes.html">classes</a>)\n
  50         *   <i>The calendar and scheduling program for KDE.</i>
  51         * - <a href="korganizer/korgac/html/index.html"><b>korgac</b></a>
  52         *   (<a href="korganizer/korgac/html/classes.html">classes</a>)\n
  53         *   <i>An alarm client for KOrganizer.</i>
  54         * - <a href="ktimetracker/html/index.html"><b>ktimetracker</b></a>
  55         *   (<a href="ktimetracker/html/classes.html">classes</a>)\n
  56         *   <i>A note taker.</i>
  57         * </td>
  58         * <td valign="top">
  59         * - <a href="libkdepim/html/index.html"><b>libkdepim</b></a>
  60         *   (<a href="libkdepim/html/classes.html">classes</a>)\n
  61         *   <i>A library of widgets and other goodies for pim.</i>
  62         * - <a href="kpgp/html/index.html"><b>kpgp</b></a>
  63         *   (<a href="libkpgp/html/classes.html">classes</a>)\n
  64         *   <i>Library for kpgp.</i>
  65         *   <i>A library for encryption handling.</i>
  66         * - <a href="kdgantt/html/index.html"><b>kdgantt</b></a>
  67         *   (<a href="kdgantt/html/classes.html">classes</a>)\n
  68         *   <i>Klarälvdalens Datakonsult AB's gantt charting engine.</i>
  69         * - <a href="kontactinterfaces/html/index.html"><b>kontactinterfaces</b></a>
  70         *   (<a href="kontactinterfaces/html/classes.html">classes</a>)\n
  71         *   <i>The glue for embedding KParts into Kontact.</i>
  72         * </td>
  73         * </tr></table>
  74         *
  75         * \section Dependencies
  76         *
  77         * \ref dependency-graph
  78         *
  79         *
  80         * \page dependency-graph Dependencies
  81         * The following graph shows the compile-time dependencies between the various kdepim and kdepimlibs modules.
  82         *
  83         * Colors:
  84         * - yellow: shared libraries
  85         * - red: static libraries
  86         * - blue: applications
  87         * - green: plugins or other non-standalone modules (kded modules, kioslaves, etc.)
  88         * - orange: code generators or other development tools
  89         * - gray: currently disabled
  90         *
  91         * Shapes:
  92         * - box: The item is located in kdepimlibs.
  93         * - ellipse: The item is located in kdepim.
  94         *
  95         * \dotfile dependency-graph.dot
  96         *
  97         */
  98 // DOXYGEN_NAME=kdepim
  99 // DOXYGEN_ENABLE=YES