diff --git a/legacy/ecore/ecore.c.in b/legacy/ecore/ecore.c.in index ed400bf594..f2337a5810 100644 --- a/legacy/ecore/ecore.c.in +++ b/legacy/ecore/ecore.c.in @@ -60,21 +60,10 @@ Suggested configure options for evas for a Linux desktop X display: make CFLAGS="-O9 -mpentiumpro -march=pentiumpro -mcpu=pentiumpro" @endverbatim -@section tutorial Ecore Tutorial - -You will find a more comprehensive @ref tut here, going through many examples -with tips and hints as to how best do some things. - @todo (1.0) Document API */ -/** @page tut Ecore Tutorial - -Here is a tutotial for using Ecore... - -*/ - /** @page Ecore_Main_Loop_Page The Ecore Main Loop @@ -286,7 +275,7 @@ number, each element is accessed using another object. Associated modules that describe the Hash ADT include: @li @ref Ecore_Data_Hash_ADT_Creation_Group @li @ref Ecore_Data_Hash_ADT_Destruction_Group -@li @ref Ecore_Data_Hash_ADT_Setting_Group +@li @ref Ecore_Data_Hash_ADT_Data_Group @todo Finish this. */ diff --git a/legacy/ecore/src/lib/ecore/ecore_hash.c b/legacy/ecore/src/lib/ecore/ecore_hash.c index 4c30a7ab9b..713ca8666c 100644 --- a/legacy/ecore/src/lib/ecore/ecore_hash.c +++ b/legacy/ecore/src/lib/ecore/ecore_hash.c @@ -127,9 +127,9 @@ int ecore_hash_set_free_value(Ecore_Hash *hash, Ecore_Free_Cb function) } /** - * @defgroup Ecore_Data_Hash_ADT_Setting_Group Hash Setting Functions + * @defgroup Ecore_Data_Hash_ADT_Data_Group Hash Data Functions * - * Functions that set values in hash tables. + * Functions that set, access and delete values from the hash tables. */ /** @@ -138,7 +138,7 @@ int ecore_hash_set_free_value(Ecore_Hash *hash, Ecore_Free_Cb function) * @param key The key. * @param value The value. * @return @c TRUE if successful, @c FALSE if not. - * @ingroup Ecore_Data_Hash_ADT_Setting_Group + * @ingroup Ecore_Data_Hash_ADT_Data_Group */ int ecore_hash_set(Ecore_Hash *hash, void *key, void *value) { @@ -162,7 +162,7 @@ int ecore_hash_set(Ecore_Hash *hash, void *key, void *value) } /** - * Free the hash table and the data contained inside it. + * Frees the hash table and the data contained inside it. * @param hash The hash table to destroy. * @return @c TRUE on success, @c FALSE on error. * @ingroup Ecore_Data_Hash_ADT_Destruction_Group @@ -193,10 +193,17 @@ void ecore_hash_destroy(Ecore_Hash *hash) } /** - * @brief Iterate over the entries in the hash table - * @param hash: the hash whose entries are iterated over - * @param for_each_func: the function each entry is passed to - * @return Returns TRUE on success, FALSE otherwise. + * @defgroup Ecore_Data_Hash_ADT_Traverse_Group Hash Traverse Functions + * + * Functions that iterate through hash tables. + */ + +/** + * Runs the @p for_each_func function on each entry in the given hash. + * @param hash The given hash. + * @param for_each_func The function that each entry is passed to. + * @return TRUE on success, FALSE otherwise. + * @ingroup Ecore_Data_Hash_ADT_Traverse_Group */ int ecore_hash_for_each_node(Ecore_Hash *hash, Ecore_For_Each for_each_func) { @@ -225,10 +232,8 @@ int ecore_hash_for_each_node(Ecore_Hash *hash, Ecore_For_Each for_each_func) } /** - * @brief Print the distribution of the hash table for graphing - * @param hash: the hash table to print - * - * Returns no value. + * Prints the distribution of the given hash table for graphing. + * @param hash The given hash table. */ void ecore_hash_dump_graph(Ecore_Hash *hash) @@ -295,11 +300,12 @@ _ecore_hash_add_node(Ecore_Hash *hash, Ecore_Hash_Node *node) } /** - * @brief Retrieve the value associated with key - * @param hash: the hash table to search for the key - * @param key: the key to search for in the hash table - * - * @return Returns NULL on error, value corresponding to key on success + * Retrieves the value associated with the given key from the given hash + * table. + * @param hash The given hash table. + * @param key The key to search for. + * @return The value corresponding to key on success, @c NULL otherwise. + * @ingroup Ecore_Data_Hash_ADT_Data_Group */ void *ecore_hash_get(Ecore_Hash *hash, void *key) { @@ -321,11 +327,13 @@ void *ecore_hash_get(Ecore_Hash *hash, void *key) /** - * @brief Remove the value associated with key - * @param hash: the hash table to remove the key from - * @param key: the key to search for in the hash table - * - * @return Returns NULL on error, value corresponding to key on success + * Removes the value associated with the given key in the given hash + * table. + * @param hash The given hash table. + * @param key The key to search for. + * @return The value corresponding to the key on success. @c NULL is + * returned if there is an error. + * @ingroup Ecore_Data_Hash_ADT_Data_Group */ void *ecore_hash_remove(Ecore_Hash *hash, void *key) { diff --git a/legacy/ecore/src/lib/ecore_config/ecore_config.c b/legacy/ecore/src/lib/ecore_config/ecore_config.c index bdea6ffeda..a0db07096c 100644 --- a/legacy/ecore/src/lib/ecore_config/ecore_config.c +++ b/legacy/ecore/src/lib/ecore_config/ecore_config.c @@ -90,6 +90,12 @@ ecore_config_dst(Ecore_Config_Prop * e) return NULL; } +/** + * @defgroup Ecore_Config_Get_Group Configuration Retrieve Functions + * + * Functions that retrieve configuration values, based on type. + */ + /** * Returns the property with the given key. * @param key The unique name of the wanted property. diff --git a/legacy/ecore/src/lib/ecore_x/ecore_x_window.c b/legacy/ecore/src/lib/ecore_x/ecore_x_window.c index 4ae123bb3b..c47f73682a 100644 --- a/legacy/ecore/src/lib/ecore_x/ecore_x_window.c +++ b/legacy/ecore/src/lib/ecore_x/ecore_x_window.c @@ -2,15 +2,22 @@ #include "ecore_x_private.h" #include "Ecore_X.h" +/** + * @defgroup Ecore_X_Window_Create_Group X Window Creation Functions + * + * Functions that can be used to create an X window. + */ + /** * Creates a new window. - * @param parent The parent window to use. If @p parent is @c 0, the root - * window of the default display is used. - * @param x X position. - * @param y Y position. - * @param w Width. - * @param h Height. - * @return The new window handle. + * @param parent The parent window to use. If @p parent is @c 0, the root + * window of the default display is used. + * @param x X position. + * @param y Y position. + * @param w Width. + * @param h Height. + * @return The new window handle. + * @ingroup Ecore_X_Window_Create_Group */ Ecore_X_Window ecore_x_window_new(Ecore_X_Window parent, int x, int y, int w, int h) @@ -59,14 +66,15 @@ ecore_x_window_new(Ecore_X_Window parent, int x, int y, int w, int h) } /** - * Create a window with the override redirect attribute set to @c True. - * @param parent The parent window to use. If @p parent is @c 0, the root - * window of the default display is used. - * @param x X position. - * @param y Y position. - * @param w Width. - * @param h Height. - * @return The new window handle. + * Creates a window with the override redirect attribute set to @c True. + * @param parent The parent window to use. If @p parent is @c 0, the root + * window of the default display is used. + * @param x X position. + * @param y Y position. + * @param w Width. + * @param h Height. + * @return The new window handle. + * @ingroup Ecore_X_Window_Create_Group */ Ecore_X_Window ecore_x_window_override_new(Ecore_X_Window parent, int x, int y, int w, int h) @@ -115,14 +123,15 @@ ecore_x_window_override_new(Ecore_X_Window parent, int x, int y, int w, int h) } /** - * Create a new input window. - * @param parent The parent window to use. If @p parent is @c 0, the root - * window of the default display is used. - * @param x X position. - * @param y Y position. - * @param w Width. - * @param h Height. - * @return The new window. + * Creates a new input window. + * @param parent The parent window to use. If @p parent is @c 0, the root + * window of the default display is used. + * @param x X position. + * @param y Y position. + * @param w Width. + * @param h Height. + * @return The new window. + * @ingroup Ecore_X_Window_Create_Group */ Ecore_X_Window ecore_x_window_input_new(Ecore_X_Window parent, int x, int y, int w, int h) @@ -162,13 +171,20 @@ ecore_x_window_input_new(Ecore_X_Window parent, int x, int y, int w, int h) return win; } +/** + * @defgroup Evas_X_Window_Properties_Group X Window Property Functions + * + * Functions that set window properties. + */ + /** * Sets the default properties for the given window. * * The default properties set for the window are @c WM_CLIENT_MACHINE and * @c _NET_WM_PID. * - * @param win The given window. + * @param win The given window. + * @ingroup Evas_X_Window_Properties_Groups */ void ecore_x_window_defaults_set(Ecore_X_Window win) @@ -210,8 +226,15 @@ ecore_x_window_defaults_set(Ecore_X_Window win) } /** - * Deletes a window. - * @param win The window to delete. + * @defgroup Evas_X_Window_Destroy_Group X Window Destroy Functions + * + * Functions to destroy X windows. + */ + +/** + * Deletes the given window. + * @param win The given window. + * @ingroup Evas_X_Window_Destroy_Group */ void ecore_x_window_del(Ecore_X_Window win) @@ -219,12 +242,19 @@ ecore_x_window_del(Ecore_X_Window win) XDestroyWindow(_ecore_x_disp, win); } +/** + * @defgroup Evas_X_Window_Visibility_Group X Window Visibility Functions + * + * Functions to access and change the visibility of X windows. + */ + /** * Shows a window. * * Synonymous to "mapping" a window in X Window System terminology. * - * @param win The window to show. + * @param win The window to show. + * @ingroup Evas_X_Window_Visibility */ void ecore_x_window_show(Ecore_X_Window win) @@ -237,7 +267,8 @@ ecore_x_window_show(Ecore_X_Window win) * * Synonymous to "unmapping" a window in X Window System terminology. * - * @param win The window to hide. + * @param win The window to hide. + * @ingroup Evas_X_Window_Visibility */ void ecore_x_window_hide(Ecore_X_Window win) @@ -245,15 +276,22 @@ ecore_x_window_hide(Ecore_X_Window win) XUnmapWindow(_ecore_x_disp, win); } +/** + * @defgroup Ecore_X_Window_Geometry_Group X Window Geometry Functions + * + * Functions that change or retrieve the geometry of X windows. + */ + /** * Moves a window to the position @p x, @p y. * * The position is relative to the upper left hand corner of the * parent window. * - * @param win The window to move. - * @param x X position. - * @param y Y position. + * @param win The window to move. + * @param x X position. + * @param y Y position. + * @ingroup Ecore_X_Window_Geometry_Group */ void ecore_x_window_move(Ecore_X_Window win, int x, int y) @@ -263,9 +301,10 @@ ecore_x_window_move(Ecore_X_Window win, int x, int y) /** * Resizes a window. - * @param win The window to resize. - * @param w New width of the window. - * @param h New height of the window. + * @param win The window to resize. + * @param w New width of the window. + * @param h New height of the window. + * @ingroup Ecore_X_Window_Geometry_Group */ void ecore_x_window_resize(Ecore_X_Window win, int w, int h) @@ -277,11 +316,12 @@ ecore_x_window_resize(Ecore_X_Window win, int w, int h) /** * Moves and resizes a window. - * @param win The window to move and resize. - * @param x New X position of the window. - * @param y New Y position of the window. - * @param w New width of the window. - * @param h New height of the window. + * @param win The window to move and resize. + * @param x New X position of the window. + * @param y New Y position of the window. + * @param w New width of the window. + * @param h New height of the window. + * @ingroup Ecore_X_Window_Geometry_Group */ void ecore_x_window_move_resize(Ecore_X_Window win, int x, int y, int w, int h) @@ -291,9 +331,16 @@ ecore_x_window_move_resize(Ecore_X_Window win, int x, int y, int w, int h) XMoveResizeWindow(_ecore_x_disp, win, x, y, w, h); } +/** + * @defgroup Ecore_X_Window_Focus_Functions X Window Focus Functions + * + * Functions that give the focus to an X Window. + */ + /** * Sets the focus to the window @p win. - * @param win The window to focus. + * @param win The window to focus. + * @ingroup Ecore_X_Window_Focus_Functions */ void ecore_x_window_focus(Ecore_X_Window win) @@ -304,8 +351,9 @@ ecore_x_window_focus(Ecore_X_Window win) /** * Sets the focus to the given window at a specific time. - * @param win The window to focus. - * @param t When to set the focus to the window. + * @param win The window to focus. + * @param t When to set the focus to the window. + * @ingroup Ecore_X_Window_Focus_Functions */ void ecore_x_window_focus_at_time(Ecore_X_Window win, Ecore_X_Time t) @@ -314,9 +362,16 @@ ecore_x_window_focus_at_time(Ecore_X_Window win, Ecore_X_Time t) XSetInputFocus(_ecore_x_disp, win, RevertToNone, t); } +/** + * @defgroup Ecore_X_Window_Z_Order_Group X Window Z Order Functions + * + * Functions that change the Z order of X windows. + */ + /** * Raises the given window. - * @param win The window to raise. + * @param win The window to raise. + * @ingroup Ecore_X_Window_Z_Order_Group */ void ecore_x_window_raise(Ecore_X_Window win) @@ -326,7 +381,8 @@ ecore_x_window_raise(Ecore_X_Window win) /** * Lowers the given window. - * @param win The window to lower. + * @param win The window to lower. + * @ingroup Ecore_X_Window_Z_Order_Group */ void ecore_x_window_lower(Ecore_X_Window win) @@ -441,8 +497,9 @@ ecore_x_window_cursor_show(Ecore_X_Window win, int show) /** * Finds out whether the given window is currently visible. - * @param win The given window. - * @return 1 if the window is visible, otherwise 0. + * @param win The given window. + * @return 1 if the window is visible, otherwise 0. + * @ingroup Ecore_X_Window_Visibility_Group */ int ecore_x_window_visible_get(Ecore_X_Window win)