enlightenment/enlightenment
enlightenment
/
enlightenment
10
9
Fork 12
Code Issues 25 Pull Requests 2 Projects Releases Wiki Activity

Add some more docs. 

Prep some structures for documentation (just modifying the code format).



SVN revision: 46451
This commit is contained in:
Christopher Michael 2010-02-25 01:17:45 +00:00
parent 5180f292dd
commit 5fda7b5150
2 changed files with 21 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/modules/illume2/doc/Doxyfile
View File

@ -459,7 +459,7 @@ QUIET = YES
# generated by doxygen. Possible values are YES and NO. If left blank # generated by doxygen. Possible values are YES and NO. If left blank
# NO is used. # NO is used.
WARNINGS = YES WARNINGS = NO
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
@ -472,7 +472,7 @@ WARN_IF_UNDOCUMENTED = NO
# parameters in a documented function, or documenting parameters that # parameters in a documented function, or documenting parameters that
# don't exist or using markup commands wrongly. # don't exist or using markup commands wrongly.
WARN_IF_DOC_ERROR = YES WARN_IF_DOC_ERROR = NO
# This WARN_NO_PARAMDOC option can be abled to get warnings for # This WARN_NO_PARAMDOC option can be abled to get warnings for
# functions that are documented, but have no documentation for their parameters # functions that are documented, but have no documentation for their parameters

27
src/modules/illume2/e_illume.h
View File

@ -34,7 +34,7 @@
* @file e_illume.h * @file e_illume.h
* *
* This header provides the various defines, structures and functions that * This header provides the various defines, structures and functions that
* make writing illume policies easier. * make writing Illume policies easier.
* *
* For details on the available functions, see @ref E_Illume_Main_Group. * For details on the available functions, see @ref E_Illume_Main_Group.
* *
@ -117,13 +117,14 @@ typedef struct _E_Illume_Keyboard
* Policy. * Policy.
* *
* @warning There are some requirements that every policy must implement and * @warning There are some requirements that every policy must implement and
* some things are optional. Please reference @ref E_Illume_Policy structure * some things are optional. Please reference the E_Illume_Policy structure
* for the requirements. * for requirements.
*/ */
/** /**
* @def E_ILLUME_POLICY_API_VERSION * @def E_ILLUME_POLICY_API_VERSION
* @brief Current version of the Policy API that is supported by the Illume module. * @brief Current version of the Policy API that is supported by the Illume
* module.
* *
* @warning Policies not written to match this version will fail to load. * @warning Policies not written to match this version will fail to load.
* *
@ -179,11 +180,15 @@ struct _E_Illume_Policy
{ {
void *(*init) (E_Illume_Policy *p); void *(*init) (E_Illume_Policy *p);
/**< pointer to the function that Illume will call to initialize this /**< pointer to the function that Illume will call to initialize this
* policy. @warning Policies are required to implement this function. */ * policy. Typically, a policy would set the pointers to the functions
* that it supports in here.
* @warning Policies are required to implement this function. */
int (*shutdown) (E_Illume_Policy *p); int (*shutdown) (E_Illume_Policy *p);
/**< pointer to the function that Illume will call to shutdown this /**< pointer to the function that Illume will call to shutdown this
* policy. @warning Policies are required to implement this function. */ * policy. Typically, a policy would do any cleanup that it needs to
* do in here.
* @warning Policies are required to implement this function. */
void (*border_add) (E_Border *bd); void (*border_add) (E_Border *bd);
/**< pointer to the function that Illume will call when a new border /**< pointer to the function that Illume will call when a new border
@ -287,15 +292,20 @@ typedef struct _E_Illume_Config
struct struct
{ {
int duration; int duration;
/**< integer specifying the amount of time it takes for an
* animation to complete. */
} vkbd, quickpanel; } vkbd, quickpanel;
} animation; } animation;
struct struct
{ {
const char *name; const char *name;
/**< the name of the currently active/selected policy. */
struct struct
{ {
const char *class, *name, *title; const char *class;
const char *name;
const char *title;
int type; int type;
struct struct
{ {
@ -316,7 +326,8 @@ typedef struct _E_Illume_Config_Zone
int id; int id;
struct struct
{ {
int dual, side; int dual;
int side;
} mode; } mode;
/* NB: These are not configurable by user...just placeholders */ /* NB: These are not configurable by user...just placeholders */