src/modules/illume2/doc/illume.dox.in

   1 /**
   2
   3 @mainpage Illume
   4
   5 @image html  e.png
   6
   7 @author Carsten Haitzler <raster\@rasterman.com>
   8 @author Christopher Michael <devilhorns\@comcast.net>
   9 @date 2000-2012
  10
  11 @section intro Introduction
  12
  13 Illume is a module for Enlightenment that modifies the user interface of
  14 enlightenment to work cleanly and nicely on a mobile device - such as an
  15 Openmoko phone. It is resolution independent meaning that it can
  16 accommodate a very wide range of devices, from cell phones and PDAs to
  17 tablets and desktops. Illume has been designed from the ground up to
  18 support multiple screens in more than one way using either xinerama or multi-head.
  19
  20 @warning This is a work in progress and as such is subject to change.
  21
  22 */
  23
  24 /**
  25 @page Illume_Main_Page Illume Basics
  26
  27 @section intro What is Illume?
  28
  29 Illume is a module for that modifies the user interface of Enlightenment to work
  30 cleanly and nicely on an embedded system - from cell phones and PDAs to tablets and
  31 desktops. It is resolution independent meaning that it can accommodate a very wide
  32 range of devices. Illume has been designed from the ground up to support multiple
  33 screens in more than one way using either xinerama or multi-head.
  34
  35 @section work How does Illume work?
  36
  37 */
  38
  39 /**
  40 @page Illume_Policy_Api_Page Illume Policy API Information
  41 */
  42
  43 /**
  44 @page Illume_Policy Illume Policy Information
  45 */
  46
  47
  48 // GROUP DEFINITIONS
  49
  50 /**
  51 @addtogroup Module_Illume2
  52 @{
  53 */
  54
  55 /**
  56 @defgroup E_Illume_Keyboard_Group Illume Keyboard Information
  57
  58 The following group defines information needed to interact with the
  59 Virtual Keyboard.
  60
  61 */
  62
  63 /**
  64 @defgroup E_Illume_Policy_Group Illume Policy Information
  65
  66 The following group defines information needed to implement an Illume
  67 Policy.
  68
  69 @warning There are some requirements that every policy must implement and
  70 some things are optional. Please reference the @ref E_Illume_Policy
  71 structure for requirements.
  72 */
  73
  74 /**
  75 @defgroup E_Illume_Config_Group Illume Configuration Information
  76
  77 The following group defines information pertaining to Illume Configuration.
  78 */
  79
  80 /**
  81 @defgroup E_Illume_Quickpanel_Group Illume Quickpanel Information
  82
  83 The following group defines information pertaining to Illume Quickpanels.
  84 */
  85
  86 /**
  87  @}
  88 */