documentation/mainpage.h

   1 /**
   2    \mainpage
   3    Welcome to the KPhotoAlbum source code documentation, which is generated with doxygen. To generate your own copy, simply run <tt>doxygen</tt> in the kphotoalbum source directory.
   4
   5    A few related pages that you should read:
   6    \li \ref coding-standards
   7    \li \ref phrase-book
   8    \li \ref common-tasks
   9
  10    KPhotoAlbum is split into a number of modules, each module is a directory of its own on the hard disk and a namespace in the source code.
  11    The following is a list of modules:
  12
  13    <h2>Main GUI component</h2>
  14    \li \ref MainWindow - The main window and associated dialogs.
  15    \li \ref Browser - This is the browser where you narrow your way to the image you want to see.
  16    \li \ref ThumbnailView - The thumbnail viewer.
  17    \li \ref Viewer - The image/video viewer.
  18    \li \ref AnnotationDialog - This is the dialog where you tag your images (the one you get to using Ctrl+1 and Ctrl+2).
  19    \li \ref DateBar - The date bar at the bottom of the main screen.
  20
  21    <h2>Other GUI components</h2>
  22    \li \ref ImportExport - Import/Export dialog and asscociated classes.
  23    \li \ref Settings - The Settings dialog and backend classes.
  24    \li \ref HTMLGenerator - The buildin HTML generator.
  25    \li \ref CategoryListView - This is the tree view used in the annotation dialog.
  26    \li \ref Exif - Exif related dialog and backend classes
  27
  28
  29    <h2>Database backend</h2>
  30    \li \ref DB The abstract interface for the database backend.
  31    \li \ref XMLDB The XML based database backend.
  32    \li \ref SQLDB The SQL based database backend - still not released.
  33
  34    <h2>Backend</h2>
  35    \li \ref ImageManager - Thumbnail loader
  36    \li \ref Plugins - KIPI plug-in management
  37    \li \ref Utilities - Miscellaneous utility classes
  38  */