jf_simon
/
enlightenment_my
forked from enlightenment/enlightenment
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Doco generation. sigh. 

SVN revision: 5607
This commit is contained in:
cpk 2001-11-02 17:28:19 +00:00 committed by cpk
parent b4e3cb64ed
commit ea3fcaaa4b
3 changed files with 20 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/menu.c
View File

@ -875,10 +875,6 @@ e_menu_select(int dx, int dy)
D_RETURN; D_RETURN;
} }
/**
* e_menu_init - Initialise the menu, adding the required
* event handlers.
*/
void void
e_menu_init(void) e_menu_init(void)
{ {

12
src/object.h
View File

@ -17,8 +17,8 @@ typedef struct _e_object
/** /**
* e_object_init - Initializes an E object * e_object_init - Initializes an E object
* @obj The object to initalize * @obj: The object to initalize
* @cleanup_func The destructor function for this object * @cleanup_func: The destructor function for this object
* *
* This function initializes an E object. It registers * This function initializes an E object. It registers
* the @cleanup_func that is to be called when the use * the @cleanup_func that is to be called when the use
@ -36,7 +36,7 @@ void e_object_init(E_Object *obj, E_Cleanup_Func cleanup_func);
/** /**
* e_object_cleanup - Cleanup function for E_Objects * e_object_cleanup - Cleanup function for E_Objects
* @obj The object to clean up * @obj: The object to clean up
* *
* This is the most basic destructor function, the only * This is the most basic destructor function, the only
* one which does not call another base class destructor * one which does not call another base class destructor
@ -47,13 +47,13 @@ void e_object_cleanup(E_Object *obj);
/** /**
* e_object_ref - Increment the reference count of this object * e_object_ref - Increment the reference count of this object
* @obj The object whose reference count to increase * @obj: The object whose reference count to increase
*/ */
void e_object_ref(E_Object *obj); void e_object_ref(E_Object *obj);
/** /**
* e_object_unref - Decrememnt the reference count of this object * e_object_unref - Decrememnt the reference count of this object
* @obj The object whose reference count to decrease * @obj: The object whose reference count to decrease
* *
* This function decreases an object's reference counter. If * This function decreases an object's reference counter. If
* the counter drops to zero, the objects cleanup_func() * the counter drops to zero, the objects cleanup_func()
@ -66,7 +66,7 @@ int e_object_unref(E_Object *obj);
/** /**
* e_object_get_usecount - Returns the current use count * e_object_get_usecount - Returns the current use count
* @obj The object whose use count to return * @obj: The object whose use count to return
* *
* This function returns the use count of an object. Use this * This function returns the use count of an object. Use this
* function when you want to perform tasks before an object * function when you want to perform tasks before an object

28
src/observer.h
View File

@ -33,10 +33,10 @@ struct _e_observee
/** /**
* e_observer_init - Initializes an observer * e_observer_init - Initializes an observer
* @obs The observer to initialize * @obs: The observer to initialize
* @event The Ecore event for which this observer will be responsible * @event: The Ecore event for which this observer will be responsible
* @nofify_func The function the observer calls when it gets notified * @notify_func: The function the observer calls when it gets notified
* @cleanup_func The destructor function to pass to the E_Object initializer * @cleanup_func: The destructor function to pass to the E_Object initializer
* *
* This function initializes an observer. Observees can register observers, * This function initializes an observer. Observees can register observers,
* which will call the given @notify_func when an observer issues an * which will call the given @notify_func when an observer issues an
@ -49,7 +49,7 @@ void e_observer_init(E_Observer *obs, Ecore_Event_Type event,
/** /**
* e_observer_cleanup - Cleans up an observer. * e_observer_cleanup - Cleans up an observer.
* @obs The observer to clean up * @obs: The observer to clean up
* *
* This function cleans up an observer by unregistering all observees. * This function cleans up an observer by unregistering all observees.
*/ */
@ -57,8 +57,8 @@ void e_observer_cleanup(E_Observer *obs);
/** /**
* e_observer_register_observee - Registers an observee * e_observer_register_observee - Registers an observee
* @observer The observer which registers the observee * @observer: The observer which registers the observee
* @observee The observee which registers the observer * @observee: The observee which registers the observer
* *
* This function registers the observer in the observee and vice versa. * This function registers the observer in the observee and vice versa.
*/ */
@ -66,8 +66,8 @@ void e_observer_register_observee(E_Observer *observer, E_Observee *observee)
/** /**
* e_observer_unregister_observee - Unregisters an observee * e_observer_unregister_observee - Unregisters an observee
* @observer The observer which unregisters the observee * @observer: The observer which unregisters the observee
* @observee The observee which unregisters the observer * @observee: The observee which unregisters the observer
* *
* This function unregisters the observer in the observee and vice versa. * This function unregisters the observer in the observee and vice versa.
*/ */
@ -75,8 +75,8 @@ void e_observer_unregister_observee(E_Observer *observer, E_Observee *observe
/** /**
* e_observee_init - Initializes an observee. * e_observee_init - Initializes an observee.
* @obs The observee to initialize * @obs: The observee to initialize
* @cleanup_func The destructor function for cleaning this observee up * @cleanup_func: The destructor function for cleaning this observee up
* *
* This function initializes an observee. Observees are derived * This function initializes an observee. Observees are derived
* from E_Objects, which is why this function gets the destructor * from E_Objects, which is why this function gets the destructor
@ -86,7 +86,7 @@ void e_observee_init(E_Observee *obs, E_Cleanup_Func cleanup_func);
/** /**
* e_observee_cleanup - Cleans up an observee. * e_observee_cleanup - Cleans up an observee.
* @obs The observee to clean up * @obs: The observee to clean up
* *
* This function cleans up an observee by unregistering it from all observers. * This function cleans up an observee by unregistering it from all observers.
*/ */
@ -94,8 +94,8 @@ void e_observee_cleanup(E_Observee *obs);
/** /**
* e_observee_notify_observers - Notify observers of a given Ecore event * e_observee_notify_observers - Notify observers of a given Ecore event
* @o The observee which notifies its observers * @o: The observee which notifies its observers
* @event The event by which to filter the observers * @event: The event by which to filter the observers
* *
* This function scans the registered observers in the observee * This function scans the registered observers in the observee
* and calls the notify_func() of the observers that are * and calls the notify_func() of the observers that are