interfaces/Mainpage.dox

   1 /** @mainpage Interfaces
   2
   3 This section collects interfaces that can be implemented
   4 by components. The interfaces provide well-defined functionality
   5 and make it possible to substitute one component (that implements
   6 a given interface) for another.
   7
   8 Documented interfaces are:
   9
  10 <dl>
  11     <dt>KHexEdit</dt>
  12     <dd>API for a byte editor<br>
  13         [ <a href="../khexedit/html/index.html">Documentation</a> |
  14           <a href="../khexedit/html/classes.html">Classes</a> ]</dd>
  15
  16     <dt>%KIMProxy</dt>
  17     <dd>API for an instant messaging service<br>
  18         [ @ref KIMProxy "Documentation" ]</dd>
  19
  20     <dt>KMediaPlayer</dt>
  21     <dd>API for re-usable media player components<br>
  22         [ <a href="../kmediaplayer/html/index.html">Documentation</a> |
  23           <a href="../kmediaplayer/html/classes.html">Classes</a> ]</dd>
  24
  25     <dt>KRegExpEditor</dt>
  26     <dd>API for a regular expression editor<br>
  27         [ @ref KRegExpEditorInterface "Documentation" ]</dd>
  28
  29     <dt>KSpeech</dt>
  30     <dd>API for a Text-to-Speech service over D-Bus<br>
  31         [ <a href="../kspeech/html/index.html">Documentation</a> |
  32           <a href="../kspeech/html/classes.html">Classes</a> ]</dd>
  33
  34     <dt>Terminal</dt>
  35     <dd>API for a console KPart<br>
  36         [ @ref TerminalInterface "Documentation" ]</dd>
  37
  38     <dt>KTextEditor</dt>
  39     <dd>API for a plain-text editor<br>
  40         [ <a href="../ktexteditor/html/index.html">Documentation</a> |
  41           <a href="../ktexteditor/html/classes.html">Classes</a> ]</dd>
  42 </dl>
  43
  44 */
  45
  46 // DOXYGEN_REFERENCES = kdecore kdeui kio kparts
  47 // DOXYGEN_EXCLUDE = khexedit kspeech ktexteditor kmediaplayer
  48 // DOXYGEN_SET_RECURSIVE = YES
  49 // DOXYGEN_SET_PROJECT_NAME = Interfaces
  50 // vim:ts=4:sw=4:expandtab:filetype=doxygen