Enlightenment CVS committal Author : dj2 Project : e17 Module : libs/ewl
Dir : e17/libs/ewl/src/lib Modified Files: ewl_embed.c ewl_menu.h ewl_menubar.h ewl_misc.c ewl_misc.h ewl_model.h ewl_mvc.c ewl_toolbar.c ewl_tree2.c Log Message: - doxygen fixes - cleanups =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_embed.c,v retrieving revision 1.111 retrieving revision 1.112 diff -u -3 -r1.111 -r1.112 --- ewl_embed.c 12 Feb 2007 13:16:05 -0000 1.111 +++ ewl_embed.c 2 Mar 2007 02:33:10 -0000 1.112 @@ -188,14 +188,14 @@ } /** - * @param emb: the embedded container to change the target evas - * @param evas: the new evas to draw the container and it's contents - * @param evas_window: the window containing the evas, for event dispatching - * @return Returns an evas smart object on success, NULL on failure. - * @brief Change the evas used by the embedded container + * @param emb: the embedded container to change the target canvas + * @param canvas: the new canvas to draw the container and it's contents + * @param canvas_window: the window containing the canvas, for event dispatching + * @return Returns an canvas object on success, NULL on failure. + * @brief Change the canvas used by the embedded container * * The returned smart object can be used to manipulate the area used by EWL - * through standard evas functions. + * through standard canvas functions. */ void * ewl_embed_canvas_set(Ewl_Embed *emb, void *canvas, Ewl_Embed_Window *canvas_window) =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_menu.h,v retrieving revision 1.23 retrieving revision 1.24 diff -u -3 -r1.23 -r1.24 --- ewl_menu.h 12 Feb 2007 13:16:05 -0000 1.23 +++ ewl_menu.h 2 Mar 2007 02:33:10 -0000 1.24 @@ -48,13 +48,19 @@ Ewl_Widget *menubar_parent; /**< Parent menu bar */ }; +/** + * A simple struct to contain menu information + */ typedef struct Ewl_Menu_Info Ewl_Menu_Info; +/** + * Provides a simple structure to contain menu information + */ struct Ewl_Menu_Info { - char *name; - char *img; - void (*cb)(Ewl_Widget *w, void *ev, void *data); + char *name; /**< The name of the menu item */ + char *img; /**< The menu item image */ + void (*cb)(Ewl_Widget *w, void *ev, void *data); /**< The menu item callback */ }; Ewl_Widget *ewl_menu_new(void); =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_menubar.h,v retrieving revision 1.14 retrieving revision 1.15 diff -u -3 -r1.14 -r1.15 --- ewl_menubar.h 6 Feb 2007 22:35:21 -0000 1.14 +++ ewl_menubar.h 2 Mar 2007 02:33:10 -0000 1.15 @@ -47,11 +47,18 @@ Ewl_Widget *inner_box; /**< The box to pack the widgets into */ }; +/** + * Ewl_Menubar_Info + */ typedef struct Ewl_Menubar_Info Ewl_Menubar_Info; + +/** + * Provides a simple menu structure for the menubar + */ struct Ewl_Menubar_Info { - char *name; - Ewl_Menu_Info *menu; + char *name; /**< The menu name */ + Ewl_Menu_Info *menu; /**< The menu items */ }; Ewl_Widget *ewl_menubar_new(void); @@ -60,7 +67,7 @@ int ewl_menubar_init(Ewl_Menubar *mb); -void ewl_menubar_from_info(Ewl_Menubar *mb, Ewl_Menubar_Info info[]); +void ewl_menubar_from_info(Ewl_Menubar *mb, Ewl_Menubar_Info *info); void ewl_menubar_orientation_set(Ewl_Menubar *mb, Ewl_Orientation o); Ewl_Orientation ewl_menubar_orientation_get(Ewl_Menubar *mb); =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_misc.c,v retrieving revision 1.83 retrieving revision 1.84 diff -u -3 -r1.83 -r1.84 --- ewl_misc.c 12 Feb 2007 13:16:05 -0000 1.83 +++ ewl_misc.c 2 Mar 2007 02:33:10 -0000 1.84 @@ -1107,6 +1107,12 @@ if (mod_dir > 0) ewl_debug_indent_lvl ++; } +/** + * @param hook: The shutdown callback to call + * @return Returns no value + * @brief Allows a widget to hookup a shutdown callback that will be called + * when Ewl is shutdown. + */ void ewl_shutdown_add(Ewl_Shutdown_Hook hook) { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_misc.h,v retrieving revision 1.24 retrieving revision 1.25 diff -u -3 -r1.24 -r1.25 --- ewl_misc.h 12 Feb 2007 13:16:05 -0000 1.24 +++ ewl_misc.h 2 Mar 2007 02:33:10 -0000 1.25 @@ -10,6 +10,12 @@ * @{ */ +/** + * @internal + * Shutdown callback typedef + */ +typedef void (*Ewl_Shutdown_Hook)(void); + int ewl_init(int *argc, char **argv); void ewl_print_help(void); int ewl_shutdown(void); @@ -22,13 +28,11 @@ void ewl_canvas_destroy(void *evas); void ewl_canvas_object_destroy(void *obj); void ewl_debug_indent_print(int mod_dir); +void ewl_shutdown_add(Ewl_Shutdown_Hook hook); /* * Internal stuff */ -typedef void (*Ewl_Shutdown_Hook)(void); -void ewl_shutdown_add(Ewl_Shutdown_Hook hook); - #undef DEBUG_MALLOCDEBUG #ifdef DEBUG_MALLOCDEBUG char *strdup(const char *str); =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_model.h,v retrieving revision 1.17 retrieving revision 1.18 diff -u -3 -r1.17 -r1.18 --- ewl_model.h 6 Feb 2007 10:56:09 -0000 1.17 +++ ewl_model.h 2 Mar 2007 02:33:10 -0000 1.18 @@ -63,9 +63,10 @@ typedef void *(*Ewl_Model_Expansion_Data_Fetch)(void *data, unsigned int row); /** - * @def EWL_MODEL_EXPANSION_MODEL_FETCH(f) ((Ewl_Model_Expansion_Model_Fetch)(f) + * @def EWL_MODEL_EXPANSION_MODEL_FETCH(f) * Model callback to get the model to use for the expansion point */ +#define EWL_MODEL_EXPANSION_MODEL_FETCH(f) ((Ewl_Model_Expansion_Model_Fetch)(f) /** * A typedef to shorten the definition of the model_expansion_model_fetch =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_mvc.c,v retrieving revision 1.18 retrieving revision 1.19 diff -u -3 -r1.18 -r1.19 --- ewl_mvc.c 7 Feb 2007 07:45:32 -0000 1.18 +++ ewl_mvc.c 2 Mar 2007 02:33:10 -0000 1.19 @@ -295,7 +295,6 @@ /** * @param mvc: The MVC to work with - * @param data: The parent data containing the index selection * @param list: The list of items to set selected. * @return Returns no value * @brief Sets the list of items to select. This will remove any items it @@ -630,6 +629,7 @@ /** * @param mvc: The MVC to work with + * @param data: UNUSED * @param row: The row to check for * @param column: The column to check for * @return Returns TRUE if the index is selected, FALSE otherwise @@ -708,6 +708,7 @@ /** * @param model: The model to work with this data + * @param data: The data that we're working with * @param srow: The start row * @param scolumn: The start column * @param erow: The end row =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_toolbar.c,v retrieving revision 1.4 retrieving revision 1.5 diff -u -3 -r1.4 -r1.5 --- ewl_toolbar.c 6 Feb 2007 13:42:17 -0000 1.4 +++ ewl_toolbar.c 2 Mar 2007 02:33:10 -0000 1.5 @@ -136,7 +136,7 @@ /** * @param t: The toolbar to set the orientation on - * @param o: The orientation to set on the toolbar + * @param part: The Ewl_Icon_Part to hide * @return Returns no value * @brief Set the orientation of the toolbar */ =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_tree2.c,v retrieving revision 1.57 retrieving revision 1.58 diff -u -3 -r1.57 -r1.58 --- ewl_tree2.c 14 Feb 2007 10:40:51 -0000 1.57 +++ ewl_tree2.c 2 Mar 2007 02:33:10 -0000 1.58 @@ -120,6 +120,7 @@ /** * @param tree: The Ewl_Tree to append the column too * @param view: The view to use for this column + * @param sortable: Is the column sortable * @return Returns no value. * @brief Append a new column to the tree */ @@ -154,6 +155,7 @@ /** * @param tree: The Ewl_Tree to prepend the column too * @param view: The view to use for this column + * @param sortable: Is the column sortable * @return Returns no value. * @brief Prepend a new column to the tree */ @@ -189,6 +191,7 @@ * @param tree: The Ewl_Tree to insert the column into * @param view: The view to use for this column * @param idx: The index to insert into + * @param sortable: Is the column sortable? * @return Returns no value. * @brief Insert a new column into the tree */ ------------------------------------------------------------------------- Take Surveys. Earn Cash. Influence the Future of IT Join SourceForge.net's Techsay panel and you'll get the chance to share your opinions on IT & business topics through brief surveys-and earn cash http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV _______________________________________________ enlightenment-cvs mailing list enlightenment-cvs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs