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

89 lines
2.1 KiB
Plaintext

/**
@mainpage Illume
@image html e.png
@author Carsten Haitzler <raster\@rasterman.com>
@author Christopher Michael <devilhorns\@comcast.net>
@date 2000-2012
@section intro Introduction
Illume is a module for Enlightenment that modifies the user interface of
enlightenment to work cleanly and nicely on a mobile device - such as an
Openmoko phone. It is resolution independent meaning that it can
accommodate a very wide range of devices, from cell phones and PDAs to
tablets and desktops. Illume has been designed from the ground up to
support multiple screens in more than one way using either xinerama or multi-head.
@warning This is a work in progress and as such is subject to change.
*/
/**
@page Illume_Main_Page Illume Basics
@section intro What is Illume?
Illume is a module for that modifies the user interface of Enlightenment to work
cleanly and nicely on an embedded system - from cell phones and PDAs to tablets and
desktops. It is resolution independent meaning that it can accommodate a very wide
range of devices. Illume has been designed from the ground up to support multiple
screens in more than one way using either xinerama or multi-head.
@section work How does Illume work?
*/
/**
@page Illume_Policy_Api_Page Illume Policy API Information
*/
/**
@page Illume_Policy Illume Policy Information
*/
// GROUP DEFINITIONS
/**
@addtogroup Module_Illume2
@{
*/
/**
@defgroup E_Illume_Keyboard_Group Illume Keyboard Information
The following group defines information needed to interact with the
Virtual Keyboard.
*/
/**
@defgroup E_Illume_Policy_Group Illume Policy Information
The following group defines information needed to implement an Illume
Policy.
@warning There are some requirements that every policy must implement and
some things are optional. Please reference the @ref E_Illume_Policy
structure for requirements.
*/
/**
@defgroup E_Illume_Config_Group Illume Configuration Information
The following group defines information pertaining to Illume Configuration.
*/
/**
@defgroup E_Illume_Quickpanel_Group Illume Quickpanel Information
The following group defines information pertaining to Illume Quickpanels.
*/
/**
@}
*/