diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index c02dd1262..03d2d90e0 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1,7 +1,7 @@ PROJECT_NAME = Enlightenment PROJECT_NUMBER = OUTPUT_DIRECTORY = . -INPUT = @builddir@/e.dox @top_srcdir@/src/bin +INPUT = @builddir@/e.dox @top_srcdir@/src IMAGE_PATH = @srcdir@/img OUTPUT_LANGUAGE = English GENERATE_HTML = YES @@ -23,9 +23,9 @@ EXTRACT_ALL = NO EXTRACT_PRIVATE = NO EXTRACT_STATIC = NO EXTRACT_LOCAL_CLASSES = NO -HIDE_UNDOC_MEMBERS = YES -HIDE_UNDOC_CLASSES = YES -HIDE_FRIEND_COMPOUNDS = YES +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES ALWAYS_DETAILED_SEC = NO @@ -76,7 +76,7 @@ REFERENCED_BY_RELATION = YES REFERENCES_RELATION = YES ALPHABETICAL_INDEX = YES COLS_IN_ALPHA_INDEX = 2 -IGNORE_PREFIX = +IGNORE_PREFIX = E_ _E_ e_ _e_ GENERATE_TREEVIEW = NO TREEVIEW_WIDTH = 250 GENERATE_LATEX = YES diff --git a/doc/e.dox.in b/doc/e.dox.in index 0b8a31e8c..9d54fc806 100644 --- a/doc/e.dox.in +++ b/doc/e.dox.in @@ -5,14 +5,89 @@ @image html e.png @version @PACKAGE_VERSION@ -@date 2000-2010 +@date 2000-2012 + +Please see the @ref authors page for contact details. @section intro Introduction -@section compiling How to compile using Enlightenment? +The Enlightenment Window Manager is a lean, fast, modular and very +extensible window manager for X11 and Linux. It is classed as a +"desktop shell" providing the things you need to operate your desktop +(or laptop), but is not a whole application suite. This covered +launching applications, managing their windows and doing other system +tasks like suspending, reboots, managing files etc. + + +@section compiling How to compile modules? + +pkgconfig (.pc) files are installed for enlightenment. To compile a +module you can use something like the following: + +@verbatim +gcc module.c $(pkg-config enlightenment --cflags --libs) +@endverbatim + +Note that modules are installed to $HOME (~/.e/e/modules) or +system. One can know the system directory with the command: + +@verbatim +pkg-config --variable=modules enlightenment +@endverbatim @section install How is it installed? +Just use the traditional autotools steps, the options will be +autodetected. Note that it depend on EFL (Enlightenment Foundation +Libraries): eina, eet, evas, ecore, e_dbus, embryo, edje, efreet and +eeze. + +@verbatim +./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var +make +sudo make install +@endverbatim + @todo (0.17) Document API */ + +/** + +@page authors Authors + +@author The Rasterman (Carsten Haitzler) +@author Ibukun Olumuyiwa +@author Sebastian Dransfeld +@author HandyAndE (Andrew Williams) +@author CodeWarrior (Hisham Mardam Bey) +@author dj2 (Dan Sinclair) +@author Tilman Sauerbeck +@author Aleksej Struk +@author Brian Mattern +@author devilhorns (Christopher Michael) +@author /dev/urandom (Viktor Kojouharov) +@author ilLogict (Chidambar Zinnoury) +@author Stafford Horne +@author Cedric Bail +@author onefang (David Seikel) +@author okra (Stephen Houston) +@author Byron Hillis +@author Ravenlock (Eric Schuele) +@author ManoWarrior (Luchezar Petkov) +@author morlenxus (Brian Miculcy) +@author Toma- (Tom Haste) +@author k-s (Gustavo Sverzut Barbieri) +@author Peter van de Werken +@author Florian Hackenberger +@author Hannes Janetzek +@author Mike Blumenkrantz (discomfitor/zmike) +@author Leif Middelschulte +@author yoz (Michael Bouchaud) +@author billiob (Boris Faure) +@author Jihoon Kim +@author Sthitha +@author Doyoun Kang +@author Gwanglim Lee + +*/ diff --git a/src/bin/e.h b/src/bin/e.h index a787c355e..53ba86c9c 100644 --- a/src/bin/e.h +++ b/src/bin/e.h @@ -1,6 +1,15 @@ #ifndef E_H # define E_H +/** + * @defgroup API Enlightenment API + * + * Application programming interface to be used by modules to extend + * Enlightenment. + * + * @{ + */ + # ifdef HAVE_CONFIG_H # include "config.h" # endif @@ -249,4 +258,25 @@ extern EAPI unsigned long e_alert_composite_win; #define SMARTERRNR() return #define SMARTERR(x) return x +/** + * @} + */ + +/** + * @defgroup Optional_Modules Optional Modules + * @{ + * + * @defgroup Optional_Conf Configurations + * @defgroup Optional_Control Controls + * @defgroup Optional_Devices Devices & Hardware + * @defgroup Optional_Fileman File Managers + * @defgroup Optional_Gadgets Gadgets + * @defgroup Optional_Launcher Launchers + * @defgroup Optional_Layouts Layout Managers + * @defgroup Optional_Look Look & Feel + * @defgroup Optional_Monitors Monitors & Notifications + * @defgroup Optional_Mobile Mobile Specific Extensions + * @} + */ + #endif diff --git a/src/modules/backlight/e_mod_main.h b/src/modules/backlight/e_mod_main.h index 4adf2f1fb..caf1daae2 100644 --- a/src/modules/backlight/e_mod_main.h +++ b/src/modules/backlight/e_mod_main.h @@ -7,4 +7,15 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Devices + * @{ + * + * @defgroup Module_Backlight Backlight + * + * Controls backlights such as laptop LCD. + * + * @} + */ + #endif diff --git a/src/modules/battery/e_mod_main.h b/src/modules/battery/e_mod_main.h index ec6543e71..6f347c820 100644 --- a/src/modules/battery/e_mod_main.h +++ b/src/modules/battery/e_mod_main.h @@ -153,4 +153,16 @@ E_Config_Dialog *e_int_config_battery_module(E_Container *con, const char *param void _battery_config_updated(void); extern Config *battery_config; +/** + * @addtogroup Optional_Gadgets + * @{ + * + * @defgroup Module_Battery Battery + * + * Shows battery level and current status, may do actions given some + * thresholds. + * + * @} + */ + #endif diff --git a/src/modules/bluez/e_mod_main.h b/src/modules/bluez/e_mod_main.h index 8796b9291..50cf31048 100644 --- a/src/modules/bluez/e_mod_main.h +++ b/src/modules/bluez/e_mod_main.h @@ -141,4 +141,17 @@ _bluez_operation_error_show(const char *msg) msg); } + +/** + * @addtogroup Optional_Devices + * @{ + * + * @defgroup Module_Bluez BlueZ (Bluetooth) + * + * Controls bluetooth visibility, scan and pair devices. + * + * @see http://www.bluez.org/ + * @} + */ + #endif diff --git a/src/modules/clock/e_mod_main.h b/src/modules/clock/e_mod_main.h index a3cfa7a72..38f3c988a 100644 --- a/src/modules/clock/e_mod_main.h +++ b/src/modules/clock/e_mod_main.h @@ -37,4 +37,16 @@ void e_int_clock_instances_redo(void); extern Config *clock_config; + +/** + * @addtogroup Optional_Gadgets + * @{ + * + * @defgroup Module_Clock Clock + * + * Shows current time and date. + * + * @} + */ + #endif diff --git a/src/modules/comp/e_mod_main.h b/src/modules/comp/e_mod_main.h index 1e69be386..cce4cf65f 100644 --- a/src/modules/comp/e_mod_main.h +++ b/src/modules/comp/e_mod_main.h @@ -31,4 +31,18 @@ void _e_mod_config_free(E_Module *m); #define ENGINE_SW 1 #define ENGINE_GL 2 + +/** + * @addtogroup Optional_Look + * @{ + * + * @defgroup Module_Comp Comp (Composite Manager) + * + * Implements the X11 Composite Manager to support alpha blend, + * semi-transparent windows and drop shadow. Does support animations + * and effects such as coloring unfocused windows. + * + * @} + */ + #endif diff --git a/src/modules/conf/e_mod_main.h b/src/modules/conf/e_mod_main.h index 90c79e144..57a2c7d1a 100644 --- a/src/modules/conf/e_mod_main.h +++ b/src/modules/conf/e_mod_main.h @@ -33,4 +33,16 @@ void e_mod_config_menu_add(void *data, E_Menu *m); extern Config *conf; +/** + * @addtogroup Optional_Conf + * @{ + * + * @defgroup Module_Conf Main Configuration Dialog + * + * Show the main configuration dialog used to access other + * configuration. + * + * @} + */ + #endif diff --git a/src/modules/conf_applications/e_mod_main.h b/src/modules/conf_applications/e_mod_main.h index 95f3a8ffc..1807193cb 100644 --- a/src/modules/conf_applications/e_mod_main.h +++ b/src/modules/conf_applications/e_mod_main.h @@ -19,4 +19,15 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Conf + * @{ + * + * @defgroup Module_Conf_Applications Applications Configuration + * + * Configure application icons (launchers ".desktop"), which + * applications to use on start or restart of Enlightenment. + * + * @} + */ #endif diff --git a/src/modules/conf_dialogs/e_mod_main.h b/src/modules/conf_dialogs/e_mod_main.h index e8df8445e..3a37dcad8 100644 --- a/src/modules/conf_dialogs/e_mod_main.h +++ b/src/modules/conf_dialogs/e_mod_main.h @@ -15,4 +15,15 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Conf + * @{ + * + * @defgroup Module_Conf_Dialogs Configuration Dialogs + * + * Controls how configuration dialogs behave (basic or advanced), as + * well as the configuration profile in use. + * + * @} + */ #endif diff --git a/src/modules/conf_display/e_mod_main.h b/src/modules/conf_display/e_mod_main.h index 4c429178b..1069f0e1f 100644 --- a/src/modules/conf_display/e_mod_main.h +++ b/src/modules/conf_display/e_mod_main.h @@ -25,4 +25,15 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Conf + * @{ + * + * @defgroup Module_Conf_Display Display Configuration + * + * Configures the physical and virtual display, including screen + * saver, screen lock and power saving settings (DPMS). + * + * @} + */ #endif diff --git a/src/modules/conf_edgebindings/e_mod_main.h b/src/modules/conf_edgebindings/e_mod_main.h index 91f7cfdc5..aa11483a8 100644 --- a/src/modules/conf_edgebindings/e_mod_main.h +++ b/src/modules/conf_edgebindings/e_mod_main.h @@ -13,4 +13,16 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Conf + * @{ + * + * @defgroup Module_Conf_EdgeBindings Edge Bindings Configuration + * + * Controls action on screen edges and corners. + * + * @see Module_Conf_MouseBindings + * @see Module_Conf_KeyBindings + * @} + */ #endif diff --git a/src/modules/conf_interaction/e_mod_main.h b/src/modules/conf_interaction/e_mod_main.h index b3e58161c..2cf513a19 100644 --- a/src/modules/conf_interaction/e_mod_main.h +++ b/src/modules/conf_interaction/e_mod_main.h @@ -15,4 +15,14 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Conf + * @{ + * + * @defgroup Module_Conf_Interaction Interaction Configuration + * + * Configure mouse and touch screen behavior. + * + * @} + */ #endif diff --git a/src/modules/conf_intl/e_mod_main.h b/src/modules/conf_intl/e_mod_main.h index 22def95ea..4818423b3 100644 --- a/src/modules/conf_intl/e_mod_main.h +++ b/src/modules/conf_intl/e_mod_main.h @@ -15,4 +15,14 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Conf + * @{ + * + * @defgroup Module_Conf_Intl Internationalization Configurations + * + * Configure language and input method (e.g. Asian languages) + * + * @} + */ #endif diff --git a/src/modules/conf_keybindings/e_mod_main.h b/src/modules/conf_keybindings/e_mod_main.h index e1f013926..f8d981e6f 100644 --- a/src/modules/conf_keybindings/e_mod_main.h +++ b/src/modules/conf_keybindings/e_mod_main.h @@ -17,4 +17,16 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Conf + * @{ + * + * @defgroup Module_Conf_KeyBinding Key Bindings (Shortcuts) Configuration + * + * Configure global keyboard shortcuts. + * + * @see Module_Conf_MouseBinding + * @see Module_Conf_EdgeBinding + * @} + */ #endif diff --git a/src/modules/conf_menus/e_mod_main.h b/src/modules/conf_menus/e_mod_main.h index 3f6eb0354..00e29695a 100644 --- a/src/modules/conf_menus/e_mod_main.h +++ b/src/modules/conf_menus/e_mod_main.h @@ -13,4 +13,14 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Conf + * @{ + * + * @defgroup Module_Conf_Menus Menu Configuration + * + * Configures Enlightenment menus. + * + * @} + */ #endif diff --git a/src/modules/conf_paths/e_mod_main.h b/src/modules/conf_paths/e_mod_main.h index 8bafe4da8..69e45edec 100644 --- a/src/modules/conf_paths/e_mod_main.h +++ b/src/modules/conf_paths/e_mod_main.h @@ -15,4 +15,18 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Conf + * @{ + * + * @defgroup Module_Conf_Paths Paths & Environment Configuration + * + * Configures where to search for fonts, icons, images, themes, + * walpapers and others. + * + * Can also configure environment variables used and propagated by + * Enlightenment to child process and applications. + * + * @} + */ #endif diff --git a/src/modules/conf_performance/e_mod_main.h b/src/modules/conf_performance/e_mod_main.h index 235e37db9..534a16a75 100644 --- a/src/modules/conf_performance/e_mod_main.h +++ b/src/modules/conf_performance/e_mod_main.h @@ -15,4 +15,15 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Conf + * @{ + * + * @defgroup Module_Conf_Performance Performance Configuration + * + * Configures the frame rate, graphics engine and other performance + * switches. + * + * @} + */ #endif diff --git a/src/modules/conf_randr/e_mod_main.h b/src/modules/conf_randr/e_mod_main.h index 8735ba71d..2166462cf 100644 --- a/src/modules/conf_randr/e_mod_main.h +++ b/src/modules/conf_randr/e_mod_main.h @@ -16,4 +16,15 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Conf + * @{ + * + * @defgroup Module_Conf_RandR RandR (Screen Resize, Rotate and Mirror) + * + * Configures size, rotation and mirroring of screen. Uses the X11 + * RandR protocol (does not work with NVidia proprietary drivers). + * + * @} + */ #endif diff --git a/src/modules/conf_shelves/e_mod_main.h b/src/modules/conf_shelves/e_mod_main.h index 390dc9e51..39ae28c0d 100644 --- a/src/modules/conf_shelves/e_mod_main.h +++ b/src/modules/conf_shelves/e_mod_main.h @@ -13,4 +13,16 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Conf + * @{ + * + * @defgroup Module_Conf_Shelves Shelves (Panels) Configuration + * + * Configure shelves (panels) that exist on screen. They may be + * horizontal or vertical, exist on top of below windows and usually + * contain sequence of @ref Optional_Gadgets. + * + * @} + */ #endif diff --git a/src/modules/conf_theme/e_mod_main.h b/src/modules/conf_theme/e_mod_main.h index 46f9fefb8..fc1ce6143 100644 --- a/src/modules/conf_theme/e_mod_main.h +++ b/src/modules/conf_theme/e_mod_main.h @@ -41,4 +41,14 @@ EAPI int e_modapi_save (E_Module *m); E_Config_Dialog *e_int_config_xsettings(E_Container *con, const char *params __UNUSED__); +/** + * @addtogroup Optional_Conf + * @{ + * + * @defgroup Module_Conf_Theme Theme Configuration + * + * Changes the graphical user interface theme and wallpaper. + * + * @} + */ #endif diff --git a/src/modules/conf_wallpaper2/e_mod_main.h b/src/modules/conf_wallpaper2/e_mod_main.h index e6e0f05c5..8eff7539d 100644 --- a/src/modules/conf_wallpaper2/e_mod_main.h +++ b/src/modules/conf_wallpaper2/e_mod_main.h @@ -12,4 +12,18 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Conf + * @{ + * + * @defgroup Module_Conf_Wallpaper2 Wallpaper2 (Alternative Selector) + * + * More graphically appealing wallpaper selector. It is targeted at + * mobile devices. + * + * @note under development and not recommended for use yet. + * + * @see Module_Conf_Theme + * @} + */ #endif diff --git a/src/modules/conf_window_manipulation/e_mod_main.h b/src/modules/conf_window_manipulation/e_mod_main.h index 1c06e354e..3dccdbe8e 100644 --- a/src/modules/conf_window_manipulation/e_mod_main.h +++ b/src/modules/conf_window_manipulation/e_mod_main.h @@ -19,4 +19,16 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Conf + * @{ + * + * @defgroup Module_Conf_Window_Manipulation Window Manipulation Configuration + * + * Configures how windows are placed, maximized, focused, stacked and + * so on. + * + * @see Module_Conf_Window_Remembers + * @} + */ #endif diff --git a/src/modules/conf_window_remembers/e_mod_main.h b/src/modules/conf_window_remembers/e_mod_main.h index 986fbaa46..bbf6d7910 100644 --- a/src/modules/conf_window_remembers/e_mod_main.h +++ b/src/modules/conf_window_remembers/e_mod_main.h @@ -12,4 +12,15 @@ EAPI void *e_modapi_init(E_Module *m); EAPI int e_modapi_shutdown(E_Module *m); EAPI int e_modapi_save(E_Module *m); +/** + * @addtogroup Optional_Conf + * @{ + * + * @defgroup Module_Conf_Window_Remembers Window Remembers Configuration + * + * Choose which windows and properties to remember, such as size, + * stacking, virtual desktop, position and so on. + * + * @} + */ #endif diff --git a/src/modules/connman/e_mod_main.h b/src/modules/connman/e_mod_main.h index c6c8013b7..91e6f22c4 100644 --- a/src/modules/connman/e_mod_main.h +++ b/src/modules/connman/e_mod_main.h @@ -181,4 +181,17 @@ _connman_ctxt_technology_find_stringshare(const E_Connman_Module_Context *ctxt, return NULL; } +/** + * @addtogroup Optional_Devices + * @{ + * + * @defgroup Module_Connman ConnMan (Connection Manager) + * + * Controls network connections for ethernet, wifi, 3G, GSM and + * bluetooth (PAN). + * + * @see http://connman.net/ + * @} + */ + #endif diff --git a/src/modules/cpufreq/e_mod_main.h b/src/modules/cpufreq/e_mod_main.h index cf05868af..75e0b488b 100644 --- a/src/modules/cpufreq/e_mod_main.h +++ b/src/modules/cpufreq/e_mod_main.h @@ -48,4 +48,17 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); + +/** + * @addtogroup Optional_Gadgets + * @{ + * + * @defgroup Module_CPUFreq CPU Frequency Monitor + * + * Monitors CPU frequency and may do actions given some thresholds. + * + * @see Module_Temperature + * @see Module_Battery + * @} + */ #endif diff --git a/src/modules/dropshadow/e_mod_main.h b/src/modules/dropshadow/e_mod_main.h index 062bc5ea4..893477233 100644 --- a/src/modules/dropshadow/e_mod_main.h +++ b/src/modules/dropshadow/e_mod_main.h @@ -109,4 +109,16 @@ EAPI int e_modapi_info (E_Module *m); void _dropshadow_cb_config_updated(void *data); + +/** + * @addtogroup Optional_Look + * @{ + * + * @defgroup Module_Dropshadow Drop Shadow + * + * Drops shadow on desktop for visible windows. This is a poor's man + * solution for people that do not have @ref Module_Comp. + * + * @} + */ #endif diff --git a/src/modules/everything/e_mod_main.h b/src/modules/everything/e_mod_main.h index 1f0b31ee3..5b2b2cdfa 100644 --- a/src/modules/everything/e_mod_main.h +++ b/src/modules/everything/e_mod_main.h @@ -371,4 +371,18 @@ extern Eina_List *_refd; extern double _evry_time; #endif + +/** + * @addtogroup Optional_Launcher + * @{ + * + * @defgroup Module_Everything Everything Launcher + * + * Flexible launcher with plugins. Can do search as you type + * filtering, browse directories, view pictures, simple math, spell + * checking and of course: launching programs and executing commands. + * + * @} + */ + #endif diff --git a/src/modules/fileman/e_mod_main.h b/src/modules/fileman/e_mod_main.h index b9fd666b6..26a7103aa 100644 --- a/src/modules/fileman/e_mod_main.h +++ b/src/modules/fileman/e_mod_main.h @@ -87,4 +87,17 @@ EAPI int e_modapi_save (E_Module *m); extern Config *fileman_config; +/** + * @addtogroup Optional_Fileman + * @{ + * + * @defgroup Module_Fileman File Manager + * + * Basic file manager with list and grid view, shows thumbnails, can + * copy, cut, paste, delete and rename files. + * + * @see Module_Fileman_Opinfo + * @} + */ + #endif diff --git a/src/modules/fileman_opinfo/e_mod_main.h b/src/modules/fileman_opinfo/e_mod_main.h index 4adf2f1fb..e495d8b7b 100644 --- a/src/modules/fileman_opinfo/e_mod_main.h +++ b/src/modules/fileman_opinfo/e_mod_main.h @@ -7,4 +7,16 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Fileman + * @{ + * + * @defgroup Module_Fileman_Opinfo File Manager Operation Information + * + * Shows information about file manager operations such as copy, move + * and delete. + * + * @} + */ + #endif diff --git a/src/modules/gadman/e_mod_main.h b/src/modules/gadman/e_mod_main.h index f884cc0aa..cffb61416 100644 --- a/src/modules/gadman/e_mod_main.h +++ b/src/modules/gadman/e_mod_main.h @@ -7,4 +7,15 @@ EAPI void *e_modapi_init(E_Module *m); EAPI int e_modapi_shutdown(E_Module *m); EAPI int e_modapi_save(E_Module *m); +/** + * @addtogroup Optional_Gadgets + * @{ + * + * @defgroup Module_Gadman Gadman (Gadget Manager) + * + * Manages @ref Optional_Gadgets on desktop or overlay. + * + * @} + */ + #endif diff --git a/src/modules/ibar/e_mod_main.h b/src/modules/ibar/e_mod_main.h index da4390e97..081187677 100644 --- a/src/modules/ibar/e_mod_main.h +++ b/src/modules/ibar/e_mod_main.h @@ -34,4 +34,15 @@ void _ibar_config_update(Config_Item *ci); void _config_ibar_module(Config_Item *ci); extern Config *ibar_config; +/** + * @addtogroup Optional_Gadgets + * @{ + * + * @defgroup Module_IBar IBar (Icon Launch Bar) + * + * Launches applications from an icon bar, usually placed on shelves. + * + * @} + */ + #endif diff --git a/src/modules/ibox/e_mod_main.h b/src/modules/ibox/e_mod_main.h index 34fe2d823..92be1435f 100644 --- a/src/modules/ibox/e_mod_main.h +++ b/src/modules/ibox/e_mod_main.h @@ -34,4 +34,15 @@ void _ibox_config_update(Config_Item *ci); void _config_ibox_module(Config_Item *ci); extern Config *ibox_config; +/** + * @addtogroup Optional_Gadgets + * @{ + * + * @defgroup Module_IBox IBox (Box of Iconified Windows) + * + * Keeps iconified (minimized) windows in a box, showing their icon + * and title. + * + * @} + */ #endif diff --git a/src/modules/illume2/doc/illume.dox.in b/src/modules/illume2/doc/illume.dox.in index ca651f364..ae52225ba 100644 --- a/src/modules/illume2/doc/illume.dox.in +++ b/src/modules/illume2/doc/illume.dox.in @@ -6,7 +6,7 @@ @author Carsten Haitzler @author Christopher Michael -@date 2000-2010 +@date 2000-2012 @section intro Introduction @@ -47,6 +47,11 @@ screens in more than one way using either xinerama or multi-head. // GROUP DEFINITIONS +/** +@addtogroup Module_Illume2 +@{ +*/ + /** @defgroup E_Illume_Keyboard_Group Illume Keyboard Information @@ -77,3 +82,7 @@ The following group defines information pertaining to Illume Configuration. The following group defines information pertaining to Illume Quickpanels. */ + +/** + @} +*/ diff --git a/src/modules/illume2/e_illume.c b/src/modules/illume2/e_illume.c index b24b77d2d..d284eb5b9 100644 --- a/src/modules/illume2/e_illume.c +++ b/src/modules/illume2/e_illume.c @@ -2,6 +2,9 @@ #include "e_mod_config.h" /** + * @addtogroup Module_Illume2 + * @{ + * * @defgroup E_Illume_Main_Group Illume API Information * * The following group defines variables, structures, and functions available @@ -1004,3 +1007,7 @@ e_illume_quickpanel_hide(E_Zone *zone) ecore_x_e_illume_quickpanel_state_send(zone->black_win, ECORE_X_ILLUME_QUICKPANEL_STATE_OFF); } + +/** + * @} + */ diff --git a/src/modules/illume2/e_mod_main.h b/src/modules/illume2/e_mod_main.h index f415823c6..50f271ec1 100644 --- a/src/modules/illume2/e_mod_main.h +++ b/src/modules/illume2/e_mod_main.h @@ -7,4 +7,16 @@ EAPI void *e_modapi_init(E_Module *m); EAPI int e_modapi_shutdown(E_Module *m); EAPI int e_modapi_save(E_Module *m); +/** + * @addtogroup Optional_Mobile + * @{ + * + * @defgroup Module_Illume2 Illume2 + * + * Second generation of Illume mobile environment for Enlightenment. + * + * @see @ref Illume_Main_Page + * + * @} + */ #endif diff --git a/src/modules/layout/e_mod_main.h b/src/modules/layout/e_mod_main.h index 4adf2f1fb..7496e1722 100644 --- a/src/modules/layout/e_mod_main.h +++ b/src/modules/layout/e_mod_main.h @@ -7,4 +7,14 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Layouts + * @{ + * + * @defgroup Module_Layout Layout Policy Enforcement + * + * Enforces window layout policies. + * + * @} + */ #endif diff --git a/src/modules/mixer/e_mod_main.h b/src/modules/mixer/e_mod_main.h index d345de9ae..ab8a18813 100644 --- a/src/modules/mixer/e_mod_main.h +++ b/src/modules/mixer/e_mod_main.h @@ -126,4 +126,19 @@ extern E_Mixer_Cb e_mod_mixer_card_name_get; extern E_Mixer_Cb e_mod_mixer_cards_get; extern E_Mixer_Cb e_mod_mixer_cards_free; extern E_Mixer_Cb e_mod_mixer_card_default_get; + +/** + * @addtogroup Optional_Devices + * @{ + * + * @defgroup Module_Mixer Audio Mixer (Volume Control) + * + * Controls the audio volume and mute status for both playback + * (output) and record (input) devices. + * + * Can work with ALSA (http://www.alsa-project.org/) or PulseAudio + * (http://www.pulseaudio.org/). + * + * @} + */ #endif diff --git a/src/modules/msgbus/e_mod_main.h b/src/modules/msgbus/e_mod_main.h index 0afdd1565..c64864e07 100644 --- a/src/modules/msgbus/e_mod_main.h +++ b/src/modules/msgbus/e_mod_main.h @@ -14,4 +14,17 @@ void msgbus_lang_init(Eina_Array *ifaces); void msgbus_desktop_init(Eina_Array *ifaces); void msgbus_audit_init(Eina_Array *ifaces); +/** + * @addtogroup Optional_Control + * @{ + * + * @defgroup Module_Msgbus MsgBus (DBus Remote Control) + * + * Allows Enlightenment to be controlled by DBus IPC (Inter Process + * Communication) protocol. + * + * @see http://www.freedesktop.org/wiki/Software/dbus + * @} + */ + #endif diff --git a/src/modules/notification/e_mod_main.h b/src/modules/notification/e_mod_main.h index e232c730c..223982544 100644 --- a/src/modules/notification/e_mod_main.h +++ b/src/modules/notification/e_mod_main.h @@ -151,4 +151,18 @@ extern E_Module *notification_mod; extern Config *notification_cfg; extern const E_Gadcon_Client_Class _gc_class; +/** + * @addtogroup Optional_Monitors + * @{ + * + * @defgroup Module_Notification Notification (Notify-OSD) + * + * Presents notifications on screen as an unobtrusive popup. It + * implements the Notify-OSD and FreeDesktop.org standards. + * + * @see http://www.galago-project.org/specs/notification/0.9/ + * @see https://wiki.ubuntu.com/NotifyOSD + * @} + */ + #endif diff --git a/src/modules/ofono/e_mod_main.h b/src/modules/ofono/e_mod_main.h index 67c9124e1..e1f66a113 100644 --- a/src/modules/ofono/e_mod_main.h +++ b/src/modules/ofono/e_mod_main.h @@ -113,4 +113,19 @@ _ofono_operation_error_show(const char *msg) msg); } +/** + * @addtogroup Optional_Devices + * @{ + * + * @defgroup Module_OFono oFono (Telephony) + * + * oFono is the Linux Telephony stack and can be used to monitor + * network signal, send and receive SMS, connect to GPRS/Edge/3G/4G. + * + * @note The plugin is barebones and can just show devices, no SMS + * management done yet. + * + * @see http://ofono.org/ + * @} + */ #endif diff --git a/src/modules/pager/e_mod_main.h b/src/modules/pager/e_mod_main.h index e3b37fc33..cb3537eaa 100644 --- a/src/modules/pager/e_mod_main.h +++ b/src/modules/pager/e_mod_main.h @@ -49,4 +49,15 @@ void _pager_cb_config_updated(void); void _config_pager_module(Config_Item *ci); extern Config *pager_config; +/** + * @addtogroup Optional_Gadgets + * @{ + * + * @defgroup Module_Pager Virtual Desktop Pager + * + * Shows the grid of virtual desktops and allows changing between + * them. + * + * @} + */ #endif diff --git a/src/modules/shot/e_mod_main.h b/src/modules/shot/e_mod_main.h index 4adf2f1fb..fd7b153cd 100644 --- a/src/modules/shot/e_mod_main.h +++ b/src/modules/shot/e_mod_main.h @@ -7,4 +7,15 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Look + * @{ + * + * @defgroup Module_Shot Screenshot + * + * Takes screen shots and can submit them to http://enlightenment.org + * + * @} + */ + #endif diff --git a/src/modules/start/e_mod_main.h b/src/modules/start/e_mod_main.h index 4adf2f1fb..617f7a425 100644 --- a/src/modules/start/e_mod_main.h +++ b/src/modules/start/e_mod_main.h @@ -7,4 +7,14 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Gadgets + * @{ + * + * @defgroup Module_Start Start Button + * + * Shows a "start here" button or icon. + * + * @} + */ #endif diff --git a/src/modules/syscon/e_mod_main.h b/src/modules/syscon/e_mod_main.h index c145a64ee..3e1742e1e 100644 --- a/src/modules/syscon/e_mod_main.h +++ b/src/modules/syscon/e_mod_main.h @@ -15,4 +15,15 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Control + * @{ + * + * @defgroup Module_Syscon SysCon (System Control) + * + * Controls your system actions such as shutdown, reboot, hibernate or + * suspend. + * + * @} + */ #endif diff --git a/src/modules/systray/e_mod_main.h b/src/modules/systray/e_mod_main.h index f884cc0aa..3ee7fa6fc 100644 --- a/src/modules/systray/e_mod_main.h +++ b/src/modules/systray/e_mod_main.h @@ -7,4 +7,17 @@ EAPI void *e_modapi_init(E_Module *m); EAPI int e_modapi_shutdown(E_Module *m); EAPI int e_modapi_save(E_Module *m); +/** + * @addtogroup Optional_Gadgets + * @{ + * + * @defgroup Module_Systray Systray (System Icons Tray) + * + * Shows system icons in a box. + * + * The icons come from the FreeDesktop.Org systray specification. + * + * @see http://standards.freedesktop.org/systemtray-spec/systemtray-spec-latest.html + * @} + */ #endif diff --git a/src/modules/tasks/e_mod_main.h b/src/modules/tasks/e_mod_main.h index f4ffc79b5..f93c60a8d 100644 --- a/src/modules/tasks/e_mod_main.h +++ b/src/modules/tasks/e_mod_main.h @@ -32,4 +32,16 @@ void _config_tasks_module(Config_Item *ci); void _tasks_config_updated(Config_Item *ci); extern Config *tasks_config; +/** + * @addtogroup Optional_Gadgets + * @{ + * + * @defgroup Module_Tasks Tasks (Task Bar) + * + * Shows windows as buttons in a box. + * + * @see Module_IBox + * + * @} + */ #endif diff --git a/src/modules/temperature/e_mod_main.h b/src/modules/temperature/e_mod_main.h index 83b3ce43e..c3ea6049a 100644 --- a/src/modules/temperature/e_mod_main.h +++ b/src/modules/temperature/e_mod_main.h @@ -82,4 +82,16 @@ void config_temperature_module(Config_Face *inst); void temperature_face_update_config(Config_Face *inst); Eina_List *temperature_get_bus_files(const char* bus); +/** + * @addtogroup Optional_Gadgets + * @{ + * + * @defgroup Module_Temperature Temperature + * + * Monitors computer temperature sensors and may do actions given some + * thresholds. + * + * @see Module_CPUFreq + * @} + */ #endif diff --git a/src/modules/winlist/e_mod_main.h b/src/modules/winlist/e_mod_main.h index aab247206..f55fa56dd 100644 --- a/src/modules/winlist/e_mod_main.h +++ b/src/modules/winlist/e_mod_main.h @@ -15,4 +15,15 @@ EAPI void *e_modapi_init (E_Module *m); EAPI int e_modapi_shutdown (E_Module *m); EAPI int e_modapi_save (E_Module *m); +/** + * @addtogroup Optional_Control + * @{ + * + * @defgroup Module_Winlist WinList (Windows Listing) + * + * Lists and switch windows, usually with "Alt-Tab" or "Alt-Shift-Tab" + * keyboard shortcuts. Can show a popup during the action. + * + * @} + */ #endif diff --git a/src/modules/wizard/e_mod_main.h b/src/modules/wizard/e_mod_main.h index 8fa859234..32c4f3a1b 100644 --- a/src/modules/wizard/e_mod_main.h +++ b/src/modules/wizard/e_mod_main.h @@ -16,4 +16,18 @@ EAPI int e_modapi_save (E_Module *m); extern E_Module *wiz_module; +/** + * @addtogroup Optional_Conf + * @{ + * + * @defgroup Module_Wizard Wizard + * + * Configures the whole Enlightenment in a nice walk-through wizard. + * + * Usually is presented on the first run of Enlightenment. The wizard + * pages are configurable and should be extended by distributions that + * want to ship Enlightenment as the default window manager. + * + * @} + */ #endif