Enlightenment CVS committal
Author : raster
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore/src/lib/ecore
Modified Files:
ecore_app.c ecore_events.c ecore_idle_enterer.c
ecore_idle_exiter.c ecore_idler.c ecore_list.c ecore_main.c
ecore_path.c ecore_sheap.c ecore_timer.c ecore_tree.c
ecore_value.c
Log Message:
nathan's docs :)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_app.c,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- ecore_app.c 20 Feb 2004 07:06:25 -0000 1.3
+++ ecore_app.c 8 May 2004 04:44:03 -0000 1.4
@@ -11,30 +11,6 @@
*
* A call to this function will store the programs command-line arguments
* for later use by ecore_app_restart() or ecore_app_args_get().
- *
- * @code
- * #include <Ecore.h>
- *
- * int timer_once(void *data)
- * {
- * int argc;
- * char **argv;
- * int i;
- *
- * ecore_app_args_get(&argc, &argv);
- * for (i = 0; i < argc; i++) printf("ARG %i: %s\n", i, argv[i]);
- * return 0;
- * }
- *
- * int main(int argc, char **argv)
- * {
- * ecore_init();
- * ecore_app_args_set(argc, argv);
- * ecore_timer_add(5.0, timer_once, NULL);
- * ecore_main_loop_begin();
- * ecore_shutdown();
- * }
- * @endcode
*/
void
ecore_app_args_set(int argc, const char **argv)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_events.c,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -3 -r1.9 -r1.10
--- ecore_events.c 4 Apr 2004 19:53:19 -0000 1.9
+++ ecore_events.c 8 May 2004 04:44:03 -0000 1.10
@@ -37,45 +37,6 @@
* event type. If it returns 0, it will cease processing handlers for that
* particular event, so all handler set to handle that event type that have not
* already been called, will not be.
- *
- * @code
- * #include <Ecore.h>
- *
- * Ecore_Event_Handler *handler1 = NULL, *handler2 = NULL;
- *
- * int event_hup(void *data, int ev_type, void *ev)
- * {
- * printf("Hup signal! Remove the exit handler.\n");
- * ecore_event_handler_del(handler1);
- * return 0;
- * }
- *
- * int event_exit(void *data, int ev_type, void *ev)
- * {
- * Ecore_Event_Signal_Exit *e;
- *
- * e = (Ecore_Event_Signal_Exit *)ev;
- * printf("This callback handles event type: %i\n", ECORE_EVENT_SIGNAL_EXIT);
- * printf("Event type recieved: %i\n", ev_type);
- * if (e->interrupt) printf("Exit: interrupt\n");
- * if (e->quit) printf("Exit: quit\n");
- * if (e->terminate) printf("Exit: terminate\n");
- * ecore_main_loop_quit();
- * return 1;
- * }
- *
- * int main(int argc, char **argv)
- * {
- * ecore_init();
- * ecore_app_args_set(argc, argv);
- * handler1 = ecore_event_handler_add(ECORE_EVENT_SIGNAL_EXIT,
- * event_exit, NULL);
- * handler2 = ecore_event_handler_add(ECORE_EVENT_SIGNAL_HUP,
- * event_hup, NULL);
- * ecore_main_loop_begin();
- * ecore_shutdown();
- * }
- * @endcode
*/
Ecore_Event_Handler *
ecore_event_handler_add(int type, int (*func) (void *data, int type, void *event),
const void *data)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_idle_enterer.c,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -3 -r1.4 -r1.5
--- ecore_idle_enterer.c 18 Mar 2004 05:29:54 -0000 1.4
+++ ecore_idle_enterer.c 8 May 2004 04:44:03 -0000 1.5
@@ -6,18 +6,11 @@
/**
* Add an idle enterer handler.
- * @param func The function to call when entering an idle state.
- * @param data The data to be passed to the @p func call
- * @return A handle to the idle enterer callback
- *
- * This function adds an idle enterer handler and returns its handle on success
- * or NULL on failure. Idle enterers are called just before he program goes
- * int an idle state where it is waiting on timers to time out, data to come
- * in on file descriptors, etc. The program will be in a "sleeping" state
- * after all the idle enterer callbacks are called. This is a good callback to
- * use to update your program's state if it has a state engine. Do all your
- * heavy processing here to update state (like drawing etc.). When @p func
- * is called, it will be passed the pointer @p data.
+ * @param func The function to call when entering an idle state.
+ * @param data The data to be passed to the @p func call
+ * @return A handle to the idle enterer callback if successful. Otherwise,
+ * NULL is returned.
+ * @ingroup Idle_Group
*/
Ecore_Idle_Enterer *
ecore_idle_enterer_add(int (*func) (void *data), const void *data)
@@ -35,13 +28,11 @@
}
/**
- * Delete an idle enter handler.
- * @param idle_enterer The idle enterer to delete
- *
- * Delete the specified @p idle_enterer from the set of idle_enterers that are
- * executed during main loop execution. On success the data pointer that was
- * being passed to the idle handler function, set by ecore_idle_enterer_add()
- * will be returned.
+ * Delete an idle enterer callback.
+ * @param idle_enterer The idle enterer to delete
+ * @return The data pointer passed to the idler enterer callback on success.
+ * NULL otherwise.
+ * @ingroup Idle_Group
*/
void *
ecore_idle_enterer_del(Ecore_Idle_Enterer *idle_enterer)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_idle_exiter.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- ecore_idle_exiter.c 18 Mar 2004 05:29:54 -0000 1.2
+++ ecore_idle_exiter.c 8 May 2004 04:44:03 -0000 1.3
@@ -8,13 +8,8 @@
* Add an idle exiter handler.
* @param func The function to call when exiting an idle state.
* @param data The data to be passed to the @p func call
- * @return A handle to the idle exiter callback
- *
- * This function adds an idle exiter handler and returns its handle on success
- * or NULL on failure. Idle exiters are called just after he program wakes up
- * from an idle state where it is waiting on timers to time out, data to come
- * in on file descriptors, etc. When @p func is called, it will be passed
- * the pointer @p data.
+ * @return A handle to the idle exiter callback on success. NULL otherwise.
+ * @ingroup Idle_Group
*/
Ecore_Idle_Exiter *
ecore_idle_exiter_add(int (*func) (void *data), const void *data)
@@ -32,13 +27,11 @@
}
/**
- * Delete an idle exit handler.
+ * Delete an idle exiter handler from the list to be run on exiting idle state.
* @param idle_exiter The idle exiter to delete
- *
- * Delete the specified @p idle_exiter from the set of idle_exiters that are
- * executed during main loop execution. On success the data pointer that was
- * being passed to the idle handler function, set by ecore_idle_exiter_add()
- * will be returned.
+ * @return The data pointer that was being being passed to the handler if
+ * successful. NULL otherwise.
+ * @ingroup Idle_Group
*/
void *
ecore_idle_exiter_del(Ecore_Idle_Exiter *idle_exiter)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_idler.c,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -3 -r1.4 -r1.5
--- ecore_idler.c 18 Mar 2004 05:29:54 -0000 1.4
+++ ecore_idler.c 8 May 2004 04:44:03 -0000 1.5
@@ -6,19 +6,10 @@
/**
* Add an idler handler.
- * @param func The function to call when idling.
- * @param data The data to be passed to this @p func call
- * @return A idler handle
- *
- * This function adds an idler handler and returns its handle on success, or
- * NULL on failure. Idlers will get called after idle enterer calls have all
- * been called and the program is in an idle state waiting on data or timers.
- * If no idler functions are set the process literally goes to sleep and uses
- * no CPU. If You have idler functions set they will be called continuously
- * during this "idle" time with your process consuming as much CPU as it can
- * get to do so. This is useful for when there are interfaces that require
- * polling and timers will mean too slow a response from the process if polling
- * is done by timers.
+ * @param func The function to call when idling.
+ * @param data The data to be passed to this @p func call.
+ * @return A idler handle if successfully added. NULL otherwise.
+ * @ingroup Idle_Group
*/
Ecore_Idler *
ecore_idler_add(int (*func) (void *data), const void *data)
@@ -36,13 +27,11 @@
}
/**
- * Delete an idler handler.
- * @param idler The idler to delete
- *
- * Delete the specified @p idler from the set of idlers that are executed
- * during main loop execution. On success the data pointer set by
- * ecore_idler_add() and passed to the idler function is returned, or NULL
- * on failure.
+ * Delete an idler callback from the list to be executed.
+ * @param idler The handle of the idler callback to delete
+ * @return The data pointer passed to the idler callback on success. NULL
+ * otherwise.
+ * @ingroup Idle_Group
*/
void *
ecore_idler_del(Ecore_Idler *idler)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_list.c,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -3 -r1.4 -r1.5
--- ecore_list.c 18 Mar 2004 19:02:23 -0000 1.4
+++ ecore_list.c 8 May 2004 04:44:03 -0000 1.5
@@ -344,9 +344,9 @@
/**
* @brief Append data to the list.
- * @param list: the list to append @data
- * @param data: the data to append to @list.
- * @return Returns FALSE if an error occurs, TRUE if appended successfully
+ * @param list The list to append @a data
+ * @param data The data to append to @a list.
+ * @return FALSE if an error occurs, TRUE if appended successfully
*/
inline int ecore_list_append(Ecore_List * list, void *data)
{
@@ -389,10 +389,10 @@
}
/**
- * @brief Prepend data to the beginning of the list
- * @param list: the list to prepend @data
- * @param data: the data to prepend to @list
- * @return Returns FALSE if an error occurs, TRUE if prepended successfully
+ * Prepend data to the beginning of the list.
+ * @param list The list to prepend @a data.
+ * @param data The data to prepend to @a list.
+ * @return FALSE if an error occurs, TRUE if prepended successfully
*/
inline int ecore_list_prepend(Ecore_List * list, void *data)
{
@@ -432,10 +432,10 @@
}
/**
- * @brief Insert data at the current point in the list
- * @param list: the list to hold the inserted @data
- * @param data: the data to insert into @list
- * @return Returns FALSE on an error, TRUE on success
+ * Insert data at the current point in the list.
+ * @param list The list to hold the inserted @a data.
+ * @param data The data to insert into @a list.
+ * @return FALSE if there is an error, TRUE on success
*/
inline int ecore_list_insert(Ecore_List * list, void *data)
{
@@ -1138,11 +1138,10 @@
}
/**
- * @brief Append data to the list.
- * @param list: the list to append @data
- * @param data: the data to append to @list
- *
- * @return Returns FALSE if an error occurs, TRUE if appended successfully
+ * Append data to the list.
+ * @param list The list to append @a data
+ * @param data The data to append to @a list
+ * @return FALSE if an error occurs, TRUE if appended successfully
*/
int ecore_dlist_append(Ecore_DList * list, void *data)
{
@@ -1169,10 +1168,10 @@
}
/**
- * @brief Prepend data to the beginning of the list
- * @param list: the list to prepend @data
- * @param data: the data to prepend to @list
- * @return Returns FALSE if an error occurs, TRUE if prepended successfully
+ * Prepend data to the beginning of the list
+ * @param list The list to prepend @a data
+ * @param data The data to prepend to @a list
+ * @return FALSE if an error occurs, TRUE if prepended successfully
*/
int ecore_dlist_prepend(Ecore_DList * list, void *data)
{
@@ -1198,9 +1197,9 @@
}
/**
- * @brief Insert data at the current point in the list
- * @param list: the list to hold the inserted @data
- * @param data: the data to insert into @list
+ * Insert data at the current point in the list.
+ * @param list The list to hold the inserted @a data.
+ * @param data The data to insert into @a list.
* @return Returns FALSE on an error, TRUE on success
*/
int ecore_dlist_insert(Ecore_DList * list, void *data)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_main.c,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -3 -r1.8 -r1.9
--- ecore_main.c 18 Mar 2004 05:29:54 -0000 1.8
+++ ecore_main.c 8 May 2004 04:44:03 -0000 1.9
@@ -22,6 +22,7 @@
/**
* Run 1 iteration of the main loop and process everything on the queue.
+ * @ingroup Ecore_Main_Loop_Group
*
* This function Processes 1 iteration of the main loop, handling anything on
* the queue. See ecore_main_loop_begin() for more information.
@@ -34,6 +35,7 @@
/**
* Run the application main loop.
+ * @ingroup Ecore_Main_Loop_Group
*
* This function does not return until ecore_main_loop_quit() is called. It
* will keep looping internally and call all callbacks set up to handle timers,
@@ -51,6 +53,7 @@
/**
* Quit the main loop after it is done processing.
+ * @ingroup Ecore_Main_Loop_Group
*
* This function will flag a quit of the main loop once the current loop has
* finished processing all events. It will not quit instantly, so expect more
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_path.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- ecore_path.c 30 Apr 2004 03:10:15 -0000 1.2
+++ ecore_path.c 8 May 2004 04:44:04 -0000 1.3
@@ -166,7 +166,7 @@
* Get a list of all available files in the path
* @param group_id The identifier for the path to get all available files
* @return A pointer to a newly allocated list of all files found in the paths
- * identified by @group_id, NULL on failure.
+ * identified by @a group_id, NULL on failure.
*/
Ecore_List *
ecore_path_group_available(int group_id)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_sheap.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- ecore_sheap.c 30 Apr 2004 03:10:15 -0000 1.2
+++ ecore_sheap.c 8 May 2004 04:44:04 -0000 1.3
@@ -55,11 +55,11 @@
/**
* Free up the memory used by the heap
- * @param heap The heap to be freed
- * @return No value.
*
- * Frees the memory used by @heap, calls the destroy function on each data
+ * Frees the memory used by @a heap, calls the destroy function on each data
* item if necessary.
+ *
+ * @param heap The heap to be freed
*/
void ecore_sheap_destroy(Ecore_Sheap *heap)
{
@@ -74,9 +74,9 @@
}
/**
- * Insert new data into the heap
- * @param heap The heap to insert @data
- * @param data The data to add to @heap
+ * Insert new data into the heap.
+ * @param heap The heap to insert @a data.
+ * @param data The data to add to @a heap.
* @return TRUE on success, NULL on failure. Increases the size of the heap if
* it becomes larger than available space.
*/
@@ -257,7 +257,6 @@
* Change the order of the heap
* @param heap The heap to change the order
* @param order The new order of the heap
- * @return No value.
*
* Changes the heap order of @heap and re-heapifies the data to this new
* order. The default order is a min heap.
@@ -274,7 +273,6 @@
/**
* Sort the data in the heap
* @param heap The heap to be sorted
- * @return No value.
*
* Sorts the data in the heap into the order that is used for the heap's
* data.
@@ -330,7 +328,6 @@
* Regain the heap properties starting at position i
* @param heap The heap to regain heap properties
* @param i The position to start heapifying
- * @return No value.
*/
static void _ecore_sheap_heapify(Ecore_Sheap *heap, int i)
{
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_timer.c,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- ecore_timer.c 18 Mar 2004 05:29:54 -0000 1.5
+++ ecore_timer.c 8 May 2004 04:44:04 -0000 1.6
@@ -15,6 +15,7 @@
* @param func The function to call when it expires
* @param data The data to pass to the function
* @return A handle to the new timer
+ * @ingroup Ecore_Timer_Group
*
* This function adds a timer and returns its handle on success and NULL on
* failure. The function @p func will be called in @p in seconds from the
@@ -27,43 +28,8 @@
* @p in value of 1.0 then the next timer will be triggered at the time this
* timer was called plus 1.0).
*
- * @code
- * #include <Ecore.h>
- *
- * Ecore_Timer *timer1 = NULL, *timer2 = NULL, *timer3 = NULL;
- *
- * int timer_tick(void *data)
- * {
- * printf("Tick timer %3.2f\n", ecore_time_get());
- * return 1;
- * }
- *
- * int timer_repeat(void *data)
- * {
- * printf("Repeat timer called at %3.2f seconds, data %p\n",
- * ecore_time_get(), data);
- * return 1;
- * }
- *
- * int timer_once(void *data)
- * {
- * printf("Once only timer called at %3.2f seconds, data %p\n",
- * ecore_time_get(), data);
- * ecore_timer_del(timer2);
- * return 0;
- * }
- *
- * int main(int argc, char **argv)
- * {
- * ecore_init();
- * ecore_app_args_set(argc, argv);
- * timer1 = ecore_timer_add(5.0, timer_once, NULL);
- * timer2 = ecore_timer_add(0.5, timer_repeat, NULL);
- * timer3 = ecore_timer_add(1.0, timer_tick, NULL);
- * ecore_main_loop_begin();
- * ecore_shutdown();
- * }
- * @endcode
+ * For more information, see the @link timer_example.c ecore_timer @endlink
+ * example.
*/
Ecore_Timer *
ecore_timer_add(double in, int (*func) (void *data), const void *data)
@@ -85,6 +51,7 @@
* Delete the specified timer from the timer list.
* @param timer
* @return The data pointer set for the timer
+ * @ingroup Ecore_Timer_Group
*
* Delete the specified @p timer from the set of timers that are executed
* during main loop execution. This function returns the data parameter that
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_tree.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- ecore_tree.c 18 Mar 2004 19:02:23 -0000 1.2
+++ ecore_tree.c 8 May 2004 04:44:04 -0000 1.3
@@ -285,10 +285,11 @@
}
/**
- * @brief Find the closest value greater >= key
- * @param tree: the tree to search
- * @param key: the key to search for in @tree
- * @return Returns NULL if no valid nodes, otherwise the node >= key
+ * @brief Find the closest value greater than or equal to the key.
+ * @param tree The tree to search.
+ * @param key The key to search for in @a tree.
+ * @return NULL if no valid nodes, otherwise the node greater than or
+ * equal to the key
*/
void *ecore_tree_get_closest_larger(Ecore_Tree * tree, void *key)
{
@@ -322,8 +323,8 @@
/**
* @brief Find the closest value <= key
- * @param tree: the tree to search
- * @param key: the key to search for in tree
+ * @param tree the tree to search
+ * @param key the key to search for in tree
* @return Returns NULL if no valid nodes, otherwise the node <= key
*/
void *ecore_tree_get_closest_smaller(Ecore_Tree * tree, void *key)
@@ -350,11 +351,11 @@
}
/**
- * @brief Set the value associated with key to @value
- * @param tree: the tree that contains the key/value pair
- * @param key: the key to identify which node to set a value
- * @param value: value to set the found node
- * @return Returns TRUE if successful, FALSE if not.
+ * Set the value associated with key to @a value.
+ * @param tree The tree that contains the key/value pair.
+ * @param key The key to identify which node to set a value.
+ * @param value Value to set the found node.
+ * @return TRUE if successful, FALSE if not.
*/
int ecore_tree_set(Ecore_Tree * tree, void *key, void *value)
{
@@ -383,10 +384,10 @@
}
/**
- * @brief Place a node in the tree
- * @param tree: the tree to add @node
- * @param node: the node to add to @tree
- * @brief Returns TRUE on a successful add, FALSE otherwise.
+ * Place a node in the tree.
+ * @param tree The tree to add @a node.
+ * @param node The node to add to @a tree.
+ * @return TRUE on a successful add, FALSE otherwise.
*/
int ecore_tree_add_node(Ecore_Tree * tree, Ecore_Tree_Node * node)
{
@@ -418,10 +419,10 @@
/**
- * @brief Remove the node from the tree
- * @param tree: the tree to remove @node
- * @param node: the node to remove from @tree
- * @return Returns TRUE on a successful remove, FALSE otherwise.
+ * Remove the node from the tree.
+ * @param tree The tree to remove @a node from.
+ * @param node The node to remove from @a tree.
+ * @return TRUE on a successful remove, FALSE otherwise.
*/
int ecore_tree_remove_node(Ecore_Tree * tree, Ecore_Tree_Node * node)
{
@@ -526,10 +527,10 @@
}
/**
- * @brief Remove the key from the tree
- * @param tree: the tree to remove @key
- * @param key: the key to remove from @tree
- * @return Returns TRUE on a successful remove, FALSE otherwise.
+ * Remove the key from the tree.
+ * @param tree The tree to remove @a key.
+ * @param key The key to remove from @a tree.
+ * @return TRUE on a successful remove, FALSE otherwise.
*/
int ecore_tree_remove(Ecore_Tree * tree, void *key)
{
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_value.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- ecore_value.c 30 Apr 2004 03:10:15 -0000 1.2
+++ ecore_value.c 8 May 2004 04:44:04 -0000 1.3
@@ -55,7 +55,7 @@
/**
* Compute the hash value of a string
* @param key A pointer to the string to compute a hash value
- * @return A computed hash value for @key.
+ * @return A computed hash value for @a key.
*/
unsigned int ecore_str_hash(void *key)
{
-------------------------------------------------------
This SF.Net email is sponsored by Sleepycat Software
Learn developer strategies Cisco, Motorola, Ericsson & Lucent use to
deliver higher performing products faster, at low TCO.
http://www.sleepycat.com/telcomwpreg.php?From=osdnemail3
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
