Enlightenment CVS committal Author : dj2 Project : e17 Module : libs/ewl
Dir : e17/libs/ewl/src/lib Modified Files: ewl_attach.c ewl_attach.h ewl_box.c ewl_box.h ewl_button.h ewl_calendar.h ewl_callback.h ewl_cell.h ewl_check.h ewl_checkbutton.h ewl_colordialog.h ewl_colorpicker.c ewl_colorpicker.h ewl_combo.h ewl_config.h ewl_container.h ewl_datepicker.h ewl_debug.h ewl_dialog.h ewl_embed.h ewl_engines.h ewl_entry.h ewl_events.h ewl_expansion.h ewl_filedialog.h ewl_filelist.h ewl_filelist_column.c ewl_filelist_column.h ewl_filelist_icon.h ewl_filelist_list.h ewl_filelist_tree.c ewl_filelist_tree.h ewl_filepicker.c ewl_filepicker.h ewl_floater.h ewl_freebox.h ewl_grid.h ewl_highlight.h ewl_histogram.h ewl_icon.h ewl_image.h ewl_io_manager.h ewl_label.h ewl_list.h ewl_media.h ewl_menu.h ewl_menu_base.h ewl_menu_item.h ewl_menubar.h ewl_model.h ewl_mvc.h ewl_notebook.h ewl_paned.c ewl_paned.h ewl_password.h ewl_popup.h ewl_progressbar.h ewl_radiobutton.h ewl_range.h ewl_row.h ewl_scrollbar.h ewl_scrollpane.h ewl_seeker.h ewl_spacer.h ewl_spectrum.h ewl_spinner.h ewl_statusbar.h ewl_stock.h ewl_table.h ewl_text.c ewl_text.h ewl_toolbar.h ewl_tree.h ewl_tree2.c ewl_tree2.h ewl_tree2_view.h ewl_tree2_view_plain.h ewl_tree2_view_scrolled.h ewl_view.h ewl_widget.h ewl_window.h Log Message: - doxy++ =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_attach.c,v retrieving revision 1.42 retrieving revision 1.43 diff -u -3 -r1.42 -r1.43 --- ewl_attach.c 3 Mar 2007 01:58:19 -0000 1.42 +++ ewl_attach.c 4 Mar 2007 00:52:01 -0000 1.43 @@ -7,7 +7,15 @@ #include "ewl_macros.h" #include "ewl_private.h" +/** + * Ewl_Attach_Tooltip + */ typedef struct Ewl_Attach_Tooltip Ewl_Attach_Tooltip; + +/** + * @brief Inherits from Ewl_Widget and extends to provide information on a + * tooltip + */ struct Ewl_Attach_Tooltip { Ewl_Widget *embed; =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_attach.h,v retrieving revision 1.19 retrieving revision 1.20 diff -u -3 -r1.19 -r1.20 --- ewl_attach.h 2 Mar 2007 04:39:46 -0000 1.19 +++ ewl_attach.h 4 Mar 2007 00:52:01 -0000 1.20 @@ -33,7 +33,7 @@ typedef struct Ewl_Attach Ewl_Attach; /** - * Contains the attachment information + * @brief Contains information about widget attachments. */ struct Ewl_Attach { @@ -50,7 +50,7 @@ typedef struct Ewl_Attach_Dnd Ewl_Attach_Dnd; /** - * DND data associated with the widget. + * @brief DND data associated with the widget. */ struct Ewl_Attach_Dnd { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_box.c,v retrieving revision 1.37 retrieving revision 1.38 diff -u -3 -r1.37 -r1.38 --- ewl_box.c 3 Mar 2007 23:21:21 -0000 1.37 +++ ewl_box.c 4 Mar 2007 00:52:01 -0000 1.38 @@ -5,6 +5,9 @@ #include "ewl_macros.h" #include "ewl_private.h" +/** + * @brief Provides information on the orientation of a box + */ typedef struct { /* =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_box.h,v retrieving revision 1.18 retrieving revision 1.19 diff -u -3 -r1.18 -r1.19 --- ewl_box.h 2 Mar 2007 04:39:46 -0000 1.18 +++ ewl_box.h 4 Mar 2007 00:52:01 -0000 1.19 @@ -43,10 +43,12 @@ #define EWL_BOX(box) ((Ewl_Box *) box) /** - * Inherits from an Ewl_Container to provide layout facilities for child - * widgets placed inside. Layout is done horizontally (left-to-right), or - * vertically (top-to-bottom). There is also a flag for homogeneous layout, - * which gives each child Ewl_Widget equal space inside the Ewl_Box. + * @brief Inherits from an Ewl_Container to provide layout facilities for child + * widgets placed inside. + * + * Layout is done horizontally (left-to-right), or vertically (top-to-bottom). + * There is also a flag for homogeneous layout, which gives each child Ewl_Widget + * equal space inside the Ewl_Box. */ struct Ewl_Box { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_button.h,v retrieving revision 1.26 retrieving revision 1.27 diff -u -3 -r1.26 -r1.27 --- ewl_button.h 2 Mar 2007 04:39:46 -0000 1.26 +++ ewl_button.h 4 Mar 2007 00:52:01 -0000 1.27 @@ -46,6 +46,7 @@ /** * @brief A simple Ewl_Widget to provide for a clickable button in the UI. + * * Provides easy facilities for adding a Ewl_Label label to the button, and * a Ewl_Image but allows for placing any number of Ewl_Widget's in the Ewl_Button. */ =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_calendar.h,v retrieving revision 1.15 retrieving revision 1.16 diff -u -3 -r1.15 -r1.16 --- ewl_calendar.h 2 Mar 2007 04:39:46 -0000 1.15 +++ ewl_calendar.h 4 Mar 2007 00:52:01 -0000 1.16 @@ -43,7 +43,8 @@ #define EWL_CALENDAR(calendar) ((Ewl_Calendar *) calendar) /** - * Inherits from an Ewl_Box to provide a calendar widget + * @brief Inherits from an Ewl_Box to provide a calendar widget + * * Layout is either free-form, or auto-arranged to a grid. */ struct Ewl_Calendar =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_callback.h,v retrieving revision 1.15 retrieving revision 1.16 diff -u -3 -r1.15 -r1.16 --- ewl_callback.h 4 Jan 2007 05:09:46 -0000 1.15 +++ ewl_callback.h 4 Mar 2007 00:52:01 -0000 1.16 @@ -32,6 +32,9 @@ */ #define EWL_CALLBACK_FUNCTION(cb_func) ((Ewl_Callback_Function) cb_func) +/** + * @brief Contains information about a callback + */ struct Ewl_Callback { Ewl_Callback_Function func; /**< Function executed */ @@ -53,7 +56,7 @@ #define EWL_CALLBACK_CUSTOM(cb) ((Ewl_Callback_Custom *)cb) /** - * The Ewl_Callback_Custom structure + * @brief Contains information about custom callbacks. */ struct Ewl_Callback_Custom { @@ -132,7 +135,6 @@ */ #define EWL_CALLBACK_SET_NODIRECT(w, t) \ w->callbacks[EWL_CALLBACK_INDEX(t)].mask &= ~EWL_CALLBACK_TYPE_DIRECT - int ewl_callbacks_init(void); void ewl_callbacks_shutdown(void); =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_cell.h,v retrieving revision 1.13 retrieving revision 1.14 diff -u -3 -r1.13 -r1.14 --- ewl_cell.h 2 Mar 2007 04:39:46 -0000 1.13 +++ ewl_cell.h 4 Mar 2007 00:52:01 -0000 1.14 @@ -41,12 +41,11 @@ #define EWL_CELL(t) ((Ewl_Cell *)t) /** - * The cell inherits from the container for packing widgets inside the - * cell. + * @brief Inherits from Ewl_Container for packing widgets inside a cell. */ struct Ewl_Cell { - Ewl_Container container; /**< Inherit from the Ewl_Container */ + Ewl_Container container; /**< Inherit from Ewl_Container */ }; Ewl_Widget *ewl_cell_new(void); =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_check.h,v retrieving revision 1.16 retrieving revision 1.17 diff -u -3 -r1.16 -r1.17 --- ewl_check.h 2 Mar 2007 04:39:46 -0000 1.16 +++ ewl_check.h 4 Mar 2007 00:52:01 -0000 1.17 @@ -42,7 +42,7 @@ #define EWL_CHECK(c) ((Ewl_Check *)c) /** - * Inherits from Ewl_Widget and extends it to provide a checked state. + * @brief Inherits from Ewl_Widget and extends to provide a checked state. */ struct Ewl_Check { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_checkbutton.h,v retrieving revision 1.17 retrieving revision 1.18 diff -u -3 -r1.17 -r1.18 --- ewl_checkbutton.h 2 Mar 2007 04:39:46 -0000 1.17 +++ ewl_checkbutton.h 4 Mar 2007 00:52:01 -0000 1.18 @@ -45,7 +45,7 @@ #define EWL_CHECKBUTTON(button) ((Ewl_Checkbutton *) button) /** - * Inherits from Ewl_Widget and expands to provide a stateful check button. + * @brief Inherits from Ewl_Button and expands to provide a stateful check button. */ struct Ewl_Checkbutton { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_colordialog.h,v retrieving revision 1.18 retrieving revision 1.19 diff -u -3 -r1.18 -r1.19 --- ewl_colordialog.h 2 Mar 2007 04:39:46 -0000 1.18 +++ ewl_colordialog.h 4 Mar 2007 00:52:01 -0000 1.19 @@ -37,7 +37,7 @@ typedef struct Ewl_Colordialog Ewl_Colordialog; /** - * Inherit from the Ewl_Dialog to create a color dialog widget + * @brief Inherit from the Ewl_Dialog to create a color dialog widget */ struct Ewl_Colordialog { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_colorpicker.c,v retrieving revision 1.36 retrieving revision 1.37 diff -u -3 -r1.36 -r1.37 --- ewl_colorpicker.c 12 Feb 2007 13:16:05 -0000 1.36 +++ ewl_colorpicker.c 4 Mar 2007 00:52:01 -0000 1.37 @@ -17,7 +17,15 @@ #define EWL_COLORPICKER_SPINNER_TYPE "colorpicker_spinner" #define EWL_COLORPICKER_SPINNER(spinner) ((Ewl_Colorpicker_Spinner *)spinner) +/** + * Ewl_Colorpicker_Spinner + */ typedef struct Ewl_Colorpicker_Spinner Ewl_Colorpicker_Spinner; + +/** + * @brief Inerits from Ewl_Spinner and extneds to provide colorpicker + * information + */ struct Ewl_Colorpicker_Spinner { Ewl_Spinner spinner; @@ -27,7 +35,15 @@ #define EWL_COLORPICKER_RADIOBUTTON_TYPE "colorpicker_radiobutton" #define EWL_COLORPICKER_RADIOBUTTON(button) ((Ewl_Colorpicker_Radiobutton *)button) +/** + * Ewl_Colorpicker_Radiobutton + */ typedef struct Ewl_Colorpicker_Radiobutton Ewl_Colorpicker_Radiobutton; + +/** + * @brief Inherits from Ewl_Radiobutton and extends to provide colorpicker + * information + */ struct Ewl_Colorpicker_Radiobutton { Ewl_Radiobutton button; =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_colorpicker.h,v retrieving revision 1.24 retrieving revision 1.25 diff -u -3 -r1.24 -r1.25 --- ewl_colorpicker.h 2 Mar 2007 04:39:46 -0000 1.24 +++ ewl_colorpicker.h 4 Mar 2007 00:52:01 -0000 1.25 @@ -37,7 +37,7 @@ typedef struct Ewl_Colorpicker Ewl_Colorpicker; /** - * This inherits from Ewl_Box to produce a color picker widget + * @brief Inherits from Ewl_Box to produce a color picker widget */ struct Ewl_Colorpicker { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_combo.h,v retrieving revision 1.24 retrieving revision 1.25 diff -u -3 -r1.24 -r1.25 --- ewl_combo.h 2 Mar 2007 04:39:46 -0000 1.24 +++ ewl_combo.h 4 Mar 2007 00:52:01 -0000 1.25 @@ -45,7 +45,7 @@ #define EWL_COMBO(combo) ((Ewl_Combo *) combo) /** - * Inherits from the Ewl_MVC widget + * @brief Inherits from the Ewl_MVC widget to provide a combo widget */ struct Ewl_Combo { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_config.h,v retrieving revision 1.21 retrieving revision 1.22 diff -u -3 -r1.21 -r1.22 --- ewl_config.h 4 Jan 2007 05:09:46 -0000 1.21 +++ ewl_config.h 4 Mar 2007 00:52:01 -0000 1.22 @@ -14,7 +14,7 @@ typedef struct Ewl_Config Ewl_Config; /** - * The Ewl_Config stuct holds configuration data + * @brief Contains Ewl configuration data */ struct Ewl_Config { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_container.h,v retrieving revision 1.30 retrieving revision 1.31 diff -u -3 -r1.30 -r1.31 --- ewl_container.h 2 Mar 2007 04:39:46 -0000 1.30 +++ ewl_container.h 4 Mar 2007 00:52:01 -0000 1.31 @@ -82,7 +82,7 @@ typedef Ewl_Widget *(*Ewl_Container_Iterator) (Ewl_Container *c); /** - * Inherits from the Ewl_Widget and expands to allow for placing child widgets + * @brief Inherits from the Ewl_Widget and expands to allow for placing child widgets * within the available space. Also adds notifiers for various child events. */ struct Ewl_Container =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_datepicker.h,v retrieving revision 1.14 retrieving revision 1.15 diff -u -3 -r1.14 -r1.15 --- ewl_datepicker.h 2 Mar 2007 04:39:46 -0000 1.14 +++ ewl_datepicker.h 4 Mar 2007 00:52:01 -0000 1.15 @@ -43,7 +43,7 @@ #define EWL_DATEPICKER(datepicker) ((Ewl_Datepicker *) datepicker) /** - * Inherits from an Ewl_Text + * @brief Inherits from Ewl_Text and extends to provide a date picker */ struct Ewl_Datepicker { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_debug.h,v retrieving revision 1.26 retrieving revision 1.27 diff -u -3 -r1.26 -r1.27 --- ewl_debug.h 6 Jan 2007 13:09:05 -0000 1.26 +++ ewl_debug.h 4 Mar 2007 00:52:01 -0000 1.27 @@ -25,7 +25,7 @@ typedef struct Ewl_Config_Cache Ewl_Config_Cache; /** - * The Ewl_Config_Cache struct holds cached configuration data + * @brief Contains cached Ewl configuration data */ struct Ewl_Config_Cache { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_dialog.h,v retrieving revision 1.17 retrieving revision 1.18 diff -u -3 -r1.17 -r1.18 --- ewl_dialog.h 2 Mar 2007 04:39:46 -0000 1.17 +++ ewl_dialog.h 4 Mar 2007 00:52:01 -0000 1.18 @@ -43,9 +43,7 @@ #define EWL_DIALOG(dialog) ((Ewl_Dialog *) dialog) /** - * Extends the Ewl_Window class. Add two boxes to hold massages (vbox) - * and buttons (action_area). The action_area could be on top, bottom, - * right or left of the window. The boxes could be separated by a line. + * @brief Inherits from Ewl_Window and extends to provide a dialog widget. */ struct Ewl_Dialog { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_embed.h,v retrieving revision 1.43 retrieving revision 1.44 diff -u -3 -r1.43 -r1.44 --- ewl_embed.h 2 Mar 2007 04:39:46 -0000 1.43 +++ ewl_embed.h 4 Mar 2007 00:52:01 -0000 1.44 @@ -54,8 +54,8 @@ #define EWL_EMBED_WINDOW(window) ((Ewl_Embed_Window *)window) /** - * @brief The class inheriting from Ewl_Container that acts as a top level - * widget for interacting with the canvas. + * @brief Inherits from Ewl_Overlay that acts as a top level widget + * for interacting with the canvas. */ struct Ewl_Embed { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_engines.h,v retrieving revision 1.23 retrieving revision 1.24 diff -u -3 -r1.23 -r1.24 --- ewl_engines.h 3 Mar 2007 00:53:38 -0000 1.23 +++ ewl_engines.h 4 Mar 2007 00:52:01 -0000 1.24 @@ -111,9 +111,20 @@ typedef enum Ewl_Engine_Pointer_Hooks Ewl_Engine_Pointer_Hooks; #define EWL_ENGINE(engine) ((Ewl_Engine *)engine) + +/** + * Ewl_Engine + */ typedef struct Ewl_Engine Ewl_Engine; +/** + * Ewl_Engine_Info + */ typedef struct Ewl_Engine_Info Ewl_Engine_Info; + +/** + * @brief Contains the function pointers provided by an engine + */ struct Ewl_Engine_Info { void (*shutdown)(Ewl_Engine *engine); /**< Shutdown the engine */ @@ -127,6 +138,9 @@ } hooks; /**< The engine hooks */ }; +/** + * @brief Contains information on an Ewl engine + */ struct Ewl_Engine { void *handle; /**< The dlsym handle */ =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_entry.h,v retrieving revision 1.26 retrieving revision 1.27 diff -u -3 -r1.26 -r1.27 --- ewl_entry.h 2 Mar 2007 04:39:46 -0000 1.26 +++ ewl_entry.h 4 Mar 2007 00:52:01 -0000 1.27 @@ -50,7 +50,7 @@ typedef struct Ewl_Entry Ewl_Entry; /** - * Inherits from Ewl_Text and extends to allow editing of the text + * @brief Inherits from Ewl_Text and extends to allow editing of the text */ struct Ewl_Entry { @@ -111,7 +111,7 @@ typedef struct Ewl_Entry_Cursor Ewl_Entry_Cursor; /** - * Inherit from Ewl_Widget and extend for the Entry cursor + * @brief Inherit from Ewl_Widget and extend for the Entry cursor */ struct Ewl_Entry_Cursor { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_events.h,v retrieving revision 1.25 retrieving revision 1.26 diff -u -3 -r1.25 -r1.26 --- ewl_events.h 3 Mar 2007 02:26:45 -0000 1.25 +++ ewl_events.h 4 Mar 2007 00:52:01 -0000 1.26 @@ -15,7 +15,7 @@ typedef struct Ewl_Event_Window_Expose Ewl_Event_Window_Expose; /** - * Describes the evas region that received an expose notification. + * @brief Describes the canvas region that received an expose notification. */ struct Ewl_Event_Window_Expose { @@ -31,7 +31,7 @@ typedef struct Ewl_Event_Key Ewl_Event_Key; /** - * Provides the basic information about key events + * @brief Provides the basic information about key events */ struct Ewl_Event_Key { @@ -45,7 +45,7 @@ typedef struct Ewl_Event_Key_Down Ewl_Event_Key_Down; /** - * Provides clients with necessary information about the key press event. + * @brief Provides clients with necessary information about the key press event. */ struct Ewl_Event_Key_Down { @@ -58,7 +58,7 @@ typedef struct Ewl_Event_Key_Up Ewl_Event_Key_Up; /** - * Provides clients with necessary information about the key release event. + * @brief Provides clients with necessary information about the key release event. */ struct Ewl_Event_Key_Up { @@ -71,7 +71,7 @@ typedef struct Ewl_Event_Mouse Ewl_Event_Mouse; /** - * Provides base mouse information + * @brief Provides base mouse information */ struct Ewl_Event_Mouse { @@ -86,7 +86,7 @@ typedef struct Ewl_Event_Mouse_Down Ewl_Event_Mouse_Down; /** - * Provides information about the mouse down event. + * @brief Provides information about the mouse down event. */ struct Ewl_Event_Mouse_Down { @@ -101,7 +101,7 @@ typedef struct Ewl_Event_Mouse_Up Ewl_Event_Mouse_Up; /** - * Provides information about the mouse up event. + * @brief Provides information about the mouse up event. */ struct Ewl_Event_Mouse_Up { @@ -115,7 +115,7 @@ typedef struct Ewl_Event_Mouse_Move Ewl_Event_Mouse_Move; /** - * Provides information about mouse movement + * @brief Provides information about mouse movement */ struct Ewl_Event_Mouse_Move { @@ -128,7 +128,7 @@ typedef struct Ewl_Event_Mouse_In Ewl_Event_Mouse_In; /** - * Provides information about the mouse entering + * @brief Provides information about the mouse entering */ struct Ewl_Event_Mouse_In { @@ -141,7 +141,7 @@ typedef struct Ewl_Event_Mouse_Out Ewl_Event_Mouse_Out; /** - * Provides information about the mouse leaving + * @brief Provides information about the mouse leaving */ struct Ewl_Event_Mouse_Out { @@ -154,7 +154,7 @@ typedef struct Ewl_Event_Mouse_Wheel Ewl_Event_Mouse_Wheel; /** - * Provides information about the mouse wheel scrolling + * @brief Provides information about the mouse wheel scrolling */ struct Ewl_Event_Mouse_Wheel { @@ -169,7 +169,7 @@ typedef struct Ewl_Dnd_Types Ewl_Dnd_Types; /** - * Provides type information about an external DND drag + * @brief Provides type information about an external DND drag */ struct Ewl_Dnd_Types { @@ -183,7 +183,7 @@ typedef struct Ewl_Event_Dnd_Position Ewl_Event_Dnd_Position; /** - * Provides information about dnd drops movement + * @brief Provides information about dnd drops movement */ struct Ewl_Event_Dnd_Position { @@ -197,7 +197,7 @@ typedef struct Ewl_Event_Dnd_Drop Ewl_Event_Dnd_Drop; /** - * Provides information about dnd drops movement + * @brief Provides information about dnd drops movement */ struct Ewl_Event_Dnd_Drop { @@ -212,7 +212,7 @@ typedef struct Ewl_Event_Dnd_Data_Received Ewl_Event_Dnd_Data_Received; /** - * Provides information about dnd drop data + * @brief Provides information about dnd drop data */ struct Ewl_Event_Dnd_Data_Received { @@ -228,7 +228,7 @@ typedef struct Ewl_Event_Dnd_Data_Request Ewl_Event_Dnd_Data_Request; /** - * Provides information about dnd data requests + * @brief Provides information about dnd data requests */ struct Ewl_Event_Dnd_Data_Request { @@ -242,7 +242,7 @@ typedef struct Ewl_Event_Action_Response Ewl_Event_Action_Response; /** - * Stores the reponse from a user action + * @brief Stores the reponse from a user action */ struct Ewl_Event_Action_Response { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_expansion.h,v retrieving revision 1.3 retrieving revision 1.4 diff -u -3 -r1.3 -r1.4 --- ewl_expansion.h 2 Mar 2007 04:39:46 -0000 1.3 +++ ewl_expansion.h 4 Mar 2007 00:52:01 -0000 1.4 @@ -40,7 +40,7 @@ #define EWL_EXPANSION(c) ((Ewl_Expansion *)c) /** - * Inherits from Ewl_Widget and extends it to provide a expansioned state. + * @brief Inherits from Ewl_Check and extends it to provide a expanded state. */ struct Ewl_Expansion { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_filedialog.h,v retrieving revision 1.19 retrieving revision 1.20 diff -u -3 -r1.19 -r1.20 --- ewl_filedialog.h 2 Mar 2007 04:39:46 -0000 1.19 +++ ewl_filedialog.h 4 Mar 2007 00:52:01 -0000 1.20 @@ -44,7 +44,7 @@ #define EWL_FILEDIALOG(fd) ((Ewl_Filedialog *) fd) /** - * Creates a dialog for the fileselector + * @brief Inherits from Ewl_Dialog and extends to create a filedialog */ struct Ewl_Filedialog { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_filelist.h,v retrieving revision 1.16 retrieving revision 1.17 diff -u -3 -r1.16 -r1.17 --- ewl_filelist.h 2 Mar 2007 04:39:46 -0000 1.16 +++ ewl_filelist.h 4 Mar 2007 00:52:01 -0000 1.17 @@ -41,7 +41,7 @@ #define EWL_FILELIST(fl) ((Ewl_Filelist *)fl) /** - * Base class for the file lists + * @brief Inherits from Ewl_Box and extends to display a file list. */ struct Ewl_Filelist { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_filelist_column.c,v retrieving revision 1.25 retrieving revision 1.26 diff -u -3 -r1.25 -r1.26 --- ewl_filelist_column.c 6 Feb 2007 13:42:17 -0000 1.25 +++ ewl_filelist_column.c 4 Mar 2007 00:52:01 -0000 1.26 @@ -7,11 +7,18 @@ #include "ewl_macros.h" #include "ewl_private.h" +/** + * @brief Stores information on the filelist column data + */ struct Ewl_Filelist_Column_Data { Ewl_Widget *list; char *dir; }; + +/** + * Ewl_Filelist_Column_Data + */ typedef struct Ewl_Filelist_Column_Data Ewl_Filelist_Column_Data;; static Ewl_View *ewl_filelist_column_view = NULL; =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_filelist_column.h,v retrieving revision 1.11 retrieving revision 1.12 diff -u -3 -r1.11 -r1.12 --- ewl_filelist_column.h 2 Mar 2007 04:39:46 -0000 1.11 +++ ewl_filelist_column.h 4 Mar 2007 00:52:01 -0000 1.12 @@ -39,7 +39,7 @@ typedef struct Ewl_Filelist_Column Ewl_Filelist_Column; /** - * Inherits from Ewl_Filelist and extends to provide a column view + * @brief Inherits from Ewl_Filelist and extends to provide a column view */ struct Ewl_Filelist_Column { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_filelist_icon.h,v retrieving revision 1.8 retrieving revision 1.9 diff -u -3 -r1.8 -r1.9 --- ewl_filelist_icon.h 2 Mar 2007 04:39:46 -0000 1.8 +++ ewl_filelist_icon.h 4 Mar 2007 00:52:01 -0000 1.9 @@ -39,7 +39,7 @@ #define EWL_FILELIST_ICON(fl) ((Ewl_Filelist_Icon *)fl) /** - * Creates the file icon view + * @brief Inherits from Ewl_Filelist and extends for an icon view */ struct Ewl_Filelist_Icon { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_filelist_list.h,v retrieving revision 1.8 retrieving revision 1.9 diff -u -3 -r1.8 -r1.9 --- ewl_filelist_list.h 2 Mar 2007 04:39:46 -0000 1.8 +++ ewl_filelist_list.h 4 Mar 2007 00:52:01 -0000 1.9 @@ -39,7 +39,7 @@ #define EWL_FILELIST_LIST(fl) ((Ewl_Filelist_List *)fl) /** - * Creats a list view on the files + * @brief Inherits from Ewl_Filelist and extends to create a list view. */ struct Ewl_Filelist_List { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_filelist_tree.c,v retrieving revision 1.5 retrieving revision 1.6 diff -u -3 -r1.5 -r1.6 --- ewl_filelist_tree.c 7 Feb 2007 07:45:32 -0000 1.5 +++ ewl_filelist_tree.c 4 Mar 2007 00:52:01 -0000 1.6 @@ -7,9 +7,15 @@ #include "ewl_macros.h" #include "ewl_private.h" +/** + * Ewl_Filelist_Tree_Data + */ typedef struct Ewl_Filelist_Tree_Data Ewl_Filelist_Tree_Data; #define EWL_FILELIST_TREE_DATA(data) ((Ewl_Filelist_Tree_Data *)(data)) +/** + * @brief Contains information on a filelist tree data + */ struct Ewl_Filelist_Tree_Data { Ewl_Filelist_Tree *list; =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_filelist_tree.h,v retrieving revision 1.3 retrieving revision 1.4 diff -u -3 -r1.3 -r1.4 --- ewl_filelist_tree.h 2 Mar 2007 04:39:46 -0000 1.3 +++ ewl_filelist_tree.h 4 Mar 2007 00:52:01 -0000 1.4 @@ -39,7 +39,7 @@ #define EWL_FILELIST_TREE(fl) ((Ewl_Filelist_Tree *)fl) /** - * Creats a tree view on the files + * @brief Inherits from Ewl_Filelist and extends to provide a tree view. */ struct Ewl_Filelist_Tree { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_filepicker.c,v retrieving revision 1.25 retrieving revision 1.26 diff -u -3 -r1.25 -r1.26 --- ewl_filepicker.c 3 Mar 2007 02:26:45 -0000 1.25 +++ ewl_filepicker.c 4 Mar 2007 00:52:01 -0000 1.26 @@ -12,7 +12,14 @@ #include "ewl_macros.h" #include "ewl_private.h" +/** + * Ewl_Filepicker_Filter + */ typedef struct Ewl_Filepicker_Filter Ewl_Filepicker_Filter; + +/** + * @brief Contains information on a filepicker filter + */ struct Ewl_Filepicker_Filter { char *name; =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_filepicker.h,v retrieving revision 1.7 retrieving revision 1.8 diff -u -3 -r1.7 -r1.8 --- ewl_filepicker.h 2 Mar 2007 04:39:46 -0000 1.7 +++ ewl_filepicker.h 4 Mar 2007 00:52:01 -0000 1.8 @@ -39,7 +39,7 @@ #define EWL_FILEPICKER(fp) ((Ewl_Filepicker *)fp) /** - * Creates a widget for selecting files + * @brief Inherits from Ewl_Box and extends to provide a filepicker. */ struct Ewl_Filepicker { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_floater.h,v retrieving revision 1.16 retrieving revision 1.17 diff -u -3 -r1.16 -r1.17 --- ewl_floater.h 2 Mar 2007 04:39:46 -0000 1.16 +++ ewl_floater.h 4 Mar 2007 00:52:01 -0000 1.17 @@ -45,7 +45,7 @@ #define EWL_FLOATER(floater) ((Ewl_Floater *) floater) /** - * Inherits from Ewl_Box for layout purposes. Provides a means to layer above + * @brief Inherits from Ewl_Box for layout purposes. Provides a means to layer above * other widgets and to follow the movement of another widget. */ struct Ewl_Floater =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_freebox.h,v retrieving revision 1.9 retrieving revision 1.10 diff -u -3 -r1.9 -r1.10 --- ewl_freebox.h 2 Mar 2007 04:39:46 -0000 1.9 +++ ewl_freebox.h 4 Mar 2007 00:52:01 -0000 1.10 @@ -44,7 +44,7 @@ typedef struct Ewl_Freebox Ewl_Freebox; /** - * Inherits from Ewl_Container and extends to allow for differnt layout + * @brief Inherits from Ewl_Container and extends to allow for differnt layout * algorithms */ struct Ewl_Freebox =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_grid.h,v retrieving revision 1.27 retrieving revision 1.28 diff -u -3 -r1.27 -r1.28 --- ewl_grid.h 2 Mar 2007 04:39:46 -0000 1.27 +++ ewl_grid.h 4 Mar 2007 00:52:01 -0000 1.28 @@ -35,7 +35,7 @@ typedef struct Ewl_Grid_Info Ewl_Grid_Info; /** - * Contains information about a row or column of Ewl_Grid + * @brief Contains information about a row or column of Ewl_Grid */ struct Ewl_Grid_Info { @@ -62,7 +62,7 @@ #define EWL_GRID(grid) ((Ewl_Grid *)grid) /** - * Inherit from Ewl_Container and extend to privide a grid layout widget + * @brief Inherit from Ewl_Container and extend to privide a grid layout widget */ struct Ewl_Grid { @@ -90,7 +90,7 @@ typedef struct Ewl_Grid_Child Ewl_Grid_Child; /** - * Contains information about a grid child + * @brief Contains information about a grid child */ struct Ewl_Grid_Child { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_highlight.h,v retrieving revision 1.5 retrieving revision 1.6 diff -u -3 -r1.5 -r1.6 --- ewl_highlight.h 2 Mar 2007 04:39:46 -0000 1.5 +++ ewl_highlight.h 4 Mar 2007 00:52:01 -0000 1.6 @@ -38,7 +38,8 @@ typedef struct Ewl_Highlight Ewl_Highlight; /** - * Inherit from Ewl_Floater + * @brief Inherits from Ewl_Floater and extends to provide a highlight + * widget. */ struct Ewl_Highlight { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_histogram.h,v retrieving revision 1.10 retrieving revision 1.11 diff -u -3 -r1.10 -r1.11 --- ewl_histogram.h 3 Mar 2007 03:28:09 -0000 1.10 +++ ewl_histogram.h 4 Mar 2007 00:52:01 -0000 1.11 @@ -37,7 +37,7 @@ typedef struct Ewl_Histogram Ewl_Histogram; /** - * Inherit from the Ewl_Image to create a histogram widget + * @brief Inherit from the Ewl_Image and extends to create a histogram widget */ struct Ewl_Histogram { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_icon.h,v retrieving revision 1.14 retrieving revision 1.15 diff -u -3 -r1.14 -r1.15 --- ewl_icon.h 2 Mar 2007 04:39:46 -0000 1.14 +++ ewl_icon.h 4 Mar 2007 00:52:01 -0000 1.15 @@ -38,7 +38,7 @@ typedef struct Ewl_Icon Ewl_Icon; /** - * Inherits from Ewl_Box and extends to provide for an icon layout + * @brief Inherits from Ewl_Stock and extends to provide for an icon layout */ struct Ewl_Icon { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_image.h,v retrieving revision 1.33 retrieving revision 1.34 diff -u -3 -r1.33 -r1.34 --- ewl_image.h 2 Mar 2007 04:39:46 -0000 1.33 +++ ewl_image.h 4 Mar 2007 00:52:01 -0000 1.34 @@ -56,7 +56,7 @@ #define EWL_IMAGE(image) ((Ewl_Image *) image) /** - * Inherits from Ewl_Widget and extends to provide an image widget + * @brief Inherits from Ewl_Widget and extends to provide an image widget */ struct Ewl_Image { @@ -90,7 +90,7 @@ #define EWL_IMAGE_THUMBNAIL_TYPE "image_thumbnail" /** - * Inherits from Ewl_Image and extends to provide reference to original image. + * @brief Inherits from Ewl_Image and extends to provide reference to original image. */ struct Ewl_Image_Thumbnail { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_io_manager.h,v retrieving revision 1.4 retrieving revision 1.5 diff -u -3 -r1.4 -r1.5 --- ewl_io_manager.h 4 Jan 2007 05:09:47 -0000 1.4 +++ ewl_io_manager.h 4 Mar 2007 00:52:01 -0000 1.5 @@ -2,7 +2,14 @@ #ifndef EWL_IO_MANAGER_H #define EWL_IO_MANAGER_H +/** + * Ewl_IO_Manager_Plugin + */ typedef struct Ewl_IO_Manager_Plugin Ewl_IO_Manager_Plugin; + +/** + * @brief Provides the base structure for IO Manager plugins + */ struct Ewl_IO_Manager_Plugin { void *handle; /**< The libray handle */ =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_label.h,v retrieving revision 1.18 retrieving revision 1.19 diff -u -3 -r1.18 -r1.19 --- ewl_label.h 2 Mar 2007 04:39:46 -0000 1.18 +++ ewl_label.h 4 Mar 2007 00:52:01 -0000 1.19 @@ -42,7 +42,7 @@ #define EWL_LABEL(label) ((Ewl_Label *)label) /** - * Inherits from Ewl_Widget class + * @brief Inherits from Ewl_Widget class to provide a simple label */ struct Ewl_Label { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_list.h,v retrieving revision 1.12 retrieving revision 1.13 diff -u -3 -r1.12 -r1.13 --- ewl_list.h 2 Mar 2007 04:39:46 -0000 1.12 +++ ewl_list.h 4 Mar 2007 00:52:01 -0000 1.13 @@ -38,7 +38,7 @@ typedef struct Ewl_List Ewl_List; /** - * Inherits from Ewl_MVC and extends to provide a list widget + * @brief Inherits from Ewl_MVC and extends to provide a list widget */ struct Ewl_List { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_media.h,v retrieving revision 1.20 retrieving revision 1.21 diff -u -3 -r1.20 -r1.21 --- ewl_media.h 2 Mar 2007 04:39:46 -0000 1.20 +++ ewl_media.h 4 Mar 2007 00:52:01 -0000 1.21 @@ -41,7 +41,7 @@ #define EWL_MEDIA(media) ((Ewl_Media *) media) /** - * Inherits from the Ewl_Widget class and extends it to provide for multi-line + * @brief Inherits from the Ewl_Widget class and extends it to provide for multi-line * media layout, obstacle wrapping, and a variety of formatting. */ struct Ewl_Media =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_menu.h,v retrieving revision 1.25 retrieving revision 1.26 diff -u -3 -r1.25 -r1.26 --- ewl_menu.h 2 Mar 2007 04:39:46 -0000 1.25 +++ ewl_menu.h 4 Mar 2007 00:52:01 -0000 1.26 @@ -44,8 +44,8 @@ #define EWL_MENU(menu) ((Ewl_Menu *) menu) /** - * Inherits from the Ewl_Menu_Base and does not extend the structure, but - * provides policy for drawing on the current evas. + * @brief Inherits from the Ewl_Menu_Base and extends to provide a simple + * menu */ struct Ewl_Menu { @@ -60,7 +60,7 @@ typedef struct Ewl_Menu_Info Ewl_Menu_Info; /** - * Provides a simple structure to contain menu information + * @brief Provides a simple structure to contain menu information */ struct Ewl_Menu_Info { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_menu_base.h,v retrieving revision 1.17 retrieving revision 1.18 diff -u -3 -r1.17 -r1.18 --- ewl_menu_base.h 2 Mar 2007 04:39:46 -0000 1.17 +++ ewl_menu_base.h 4 Mar 2007 00:52:01 -0000 1.18 @@ -44,7 +44,7 @@ #define EWL_MENU_BASE(menu) ((Ewl_Menu_Base *) menu) /** - * Inherits from Ewl_Menu_Item and extends to create the base menu + * @brief Inherits from Ewl_Menu_Item and extends to create the base menu */ struct Ewl_Menu_Base { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_menu_item.h,v retrieving revision 1.17 retrieving revision 1.18 diff -u -3 -r1.17 -r1.18 --- ewl_menu_item.h 2 Mar 2007 04:39:46 -0000 1.17 +++ ewl_menu_item.h 4 Mar 2007 00:52:01 -0000 1.18 @@ -44,8 +44,7 @@ #define EWL_MENU_ITEM(mi) ((Ewl_Menu_Item *) mi) /** - * Inherits from Ewl_Box to gain it's layout abilities, places policy on top - * of the box framework to provide a simple menu layout of icon and label. + * @brief Inherits from Ewl_Button and provides a basic menu item widget */ struct Ewl_Menu_Item { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_menubar.h,v retrieving revision 1.16 retrieving revision 1.17 diff -u -3 -r1.16 -r1.17 --- ewl_menubar.h 2 Mar 2007 04:39:46 -0000 1.16 +++ ewl_menubar.h 4 Mar 2007 00:52:01 -0000 1.17 @@ -44,7 +44,7 @@ #define EWL_MENUBAR(menubar) ((Ewl_Menubar *) menubar) /** - * Inherits from the Ewl_Box class and extends it to provide for + * @brief Inherits from the Ewl_Box class and extends it to provide for * a menubar */ struct Ewl_Menubar @@ -59,7 +59,7 @@ typedef struct Ewl_Menubar_Info Ewl_Menubar_Info; /** - * Provides a simple menu structure for the menubar + * @brief Provides a simple menu structure for the menubar */ struct Ewl_Menubar_Info { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_model.h,v retrieving revision 1.18 retrieving revision 1.19 diff -u -3 -r1.18 -r1.19 --- ewl_model.h 2 Mar 2007 02:33:10 -0000 1.18 +++ ewl_model.h 4 Mar 2007 00:52:01 -0000 1.19 @@ -106,7 +106,7 @@ #define EWL_MODEL(model) ((Ewl_Model *)model) /** - * This holds the callbacks needed to define a model + * @brief Holds the callbacks needed to define a model */ struct Ewl_Model { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_mvc.h,v retrieving revision 1.16 retrieving revision 1.17 diff -u -3 -r1.16 -r1.17 --- ewl_mvc.h 2 Mar 2007 04:39:46 -0000 1.16 +++ ewl_mvc.h 4 Mar 2007 00:52:01 -0000 1.17 @@ -40,7 +40,7 @@ typedef struct Ewl_Selection Ewl_Selection; /** - * Structure to store information on selections + * @brief Structure to store information on selections */ struct Ewl_Selection { @@ -63,7 +63,7 @@ typedef struct Ewl_Selection_Idx Ewl_Selection_Idx; /** - * Structure to store information on a single index selection + * @brief Structure to store information on a single index selection */ struct Ewl_Selection_Idx { @@ -85,7 +85,7 @@ typedef struct Ewl_Selection_Range Ewl_Selection_Range; /** - * Structure to store a range of selected cells + * @brief Structure to store a range of selected cells */ struct Ewl_Selection_Range { @@ -111,7 +111,7 @@ #define EWL_MVC(mvc) ((Ewl_MVC *)mvc) /** - * Inherits from Ewl_Box and extends to provide mvc functionality + * @brief Inherits from Ewl_Box and extends to provide mvc functionality */ struct Ewl_MVC { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_notebook.h,v retrieving revision 1.16 retrieving revision 1.17 diff -u -3 -r1.16 -r1.17 --- ewl_notebook.h 2 Mar 2007 04:39:46 -0000 1.16 +++ ewl_notebook.h 4 Mar 2007 00:52:01 -0000 1.17 @@ -47,7 +47,7 @@ typedef struct Ewl_Notebook Ewl_Notebook; /** - * Inherits from Ewl_Box and extends to provide for a notebook style layout. + * @brief Inherits from Ewl_Box and extends to provide for a notebook style layout. */ struct Ewl_Notebook { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_paned.c,v retrieving revision 1.48 retrieving revision 1.49 diff -u -3 -r1.48 -r1.49 --- ewl_paned.c 3 Mar 2007 01:58:19 -0000 1.48 +++ ewl_paned.c 4 Mar 2007 00:52:01 -0000 1.49 @@ -5,6 +5,9 @@ #include "ewl_macros.h" #include "ewl_private.h" +/** + * @brief Contains information on a paned layout + */ typedef struct { int (*minimum_size)(Ewl_Object *o); =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_paned.h,v retrieving revision 1.27 retrieving revision 1.28 diff -u -3 -r1.27 -r1.28 --- ewl_paned.h 2 Mar 2007 04:39:46 -0000 1.27 +++ ewl_paned.h 4 Mar 2007 00:52:01 -0000 1.28 @@ -47,7 +47,7 @@ typedef struct Ewl_Paned Ewl_Paned; /** - * Inherits from Ewl_Container and extends to provided the paned widget + * @brief Inherits from Ewl_Container and extends to provided the paned widget */ struct Ewl_Paned { @@ -109,7 +109,7 @@ #define EWL_PANED_GRABBER(g) ((Ewl_Paned_Grabber *)g) /** - * Inherits from Ewl_Separator and extends to facilitate the paned grabber + * @brief Inherits from Ewl_Separator and extends to facilitate the paned grabber */ struct Ewl_Paned_Grabber { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_password.h,v retrieving revision 1.14 retrieving revision 1.15 diff -u -3 -r1.14 -r1.15 --- ewl_password.h 2 Mar 2007 04:39:46 -0000 1.14 +++ ewl_password.h 4 Mar 2007 00:52:01 -0000 1.15 @@ -43,7 +43,7 @@ #define EWL_PASSWORD(password) ((Ewl_Password *) password) /** - * Inherits from the Ewl_Entry and extends it to obscure the text. + * @brief Inherits from the Ewl_Entry and extends it to obscure the text. */ struct Ewl_Password { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_popup.h,v retrieving revision 1.10 retrieving revision 1.11 diff -u -3 -r1.10 -r1.11 --- ewl_popup.h 2 Mar 2007 04:39:46 -0000 1.10 +++ ewl_popup.h 4 Mar 2007 00:52:01 -0000 1.11 @@ -37,7 +37,7 @@ #define EWL_POPUP(popup) ((Ewl_Popup *) popup) /** - * @brief Inherits from Ewl_Window + * @brief Inherits from Ewl_Window and extends to provide a popup widget */ struct Ewl_Popup { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_progressbar.h,v retrieving revision 1.16 retrieving revision 1.17 diff -u -3 -r1.16 -r1.17 --- ewl_progressbar.h 2 Mar 2007 04:39:46 -0000 1.16 +++ ewl_progressbar.h 4 Mar 2007 00:52:01 -0000 1.17 @@ -45,8 +45,8 @@ #define EWL_PROGRESSBAR(progressbar) ((Ewl_Progressbar *) progressbar) /** - * Inherits from Ewl_Range and creates an internal Ewl_Widget, the - * statusbar itself. + * @brief Inherits from Ewl_Range and extends to provide a progressbar + * widget */ struct Ewl_Progressbar { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_radiobutton.h,v retrieving revision 1.15 retrieving revision 1.16 diff -u -3 -r1.15 -r1.16 --- ewl_radiobutton.h 2 Mar 2007 04:39:46 -0000 1.15 +++ ewl_radiobutton.h 4 Mar 2007 00:52:01 -0000 1.16 @@ -45,7 +45,7 @@ #define EWL_RADIOBUTTON(button) ((Ewl_Radiobutton *) button) /** - * Inherits from Ewl_Checkbutton and extends it to provide grouping buttons + * @brief Inherits from Ewl_Checkbutton and extends it to provide grouping buttons * to limit to a single selection in a group at a given time. */ struct Ewl_Radiobutton =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_range.h,v retrieving revision 1.7 retrieving revision 1.8 diff -u -3 -r1.7 -r1.8 --- ewl_range.h 2 Mar 2007 04:39:46 -0000 1.7 +++ ewl_range.h 4 Mar 2007 00:52:01 -0000 1.8 @@ -38,8 +38,8 @@ #define EWL_RANGE(range) ((Ewl_Range *) range) /** - * Inherits from Ewl_Container and creates internal Ewl_Widget's to provide a - * range and a draggable area to select a value from that range. + * @brief Inherits from Ewl_Container and extends to provide a basic range + * widget */ struct Ewl_Range { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_row.h,v retrieving revision 1.15 retrieving revision 1.16 diff -u -3 -r1.15 -r1.16 --- ewl_row.h 2 Mar 2007 04:39:47 -0000 1.15 +++ ewl_row.h 4 Mar 2007 00:52:01 -0000 1.16 @@ -40,8 +40,8 @@ */ #define EWL_ROW(t) ((Ewl_Row *)t) -/* - * Inherits from Ewl_Container to create a tree rows that +/** + * @brief Inherits from Ewl_Container to create a tree row that * lays out cells in a left to right fashion. */ struct Ewl_Row =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_scrollbar.h,v retrieving revision 1.17 retrieving revision 1.18 diff -u -3 -r1.17 -r1.18 --- ewl_scrollbar.h 2 Mar 2007 04:39:47 -0000 1.17 +++ ewl_scrollbar.h 4 Mar 2007 00:52:01 -0000 1.18 @@ -56,8 +56,7 @@ #define EWL_SCROLLBAR(scrollbar) ((Ewl_Scrollbar *) scrollbar) /** - * Inherits from Ewl_Box to layout an Ewl_Seeker and two Ewl_Buttons to - * provide scrollbar functionality. + * @brief Inherits from Ewl_Box and extends to provide a scrollbar widget */ struct Ewl_Scrollbar { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_scrollpane.h,v retrieving revision 1.16 retrieving revision 1.17 diff -u -3 -r1.16 -r1.17 --- ewl_scrollpane.h 2 Mar 2007 04:39:47 -0000 1.16 +++ ewl_scrollpane.h 4 Mar 2007 00:52:01 -0000 1.17 @@ -42,7 +42,7 @@ #define EWL_SCROLLPANE(scrollpane) ((Ewl_Scrollpane *) scrollpane) /** - * Inherits from Ewl_Container and extends it to enclose a single widget in + * @brief Inherits from Ewl_Container and extends it to enclose a single widget in * vertical and horizontal scrollbars for panning around displaying different * regions of the enclosed widget. */ =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_seeker.h,v retrieving revision 1.20 retrieving revision 1.21 diff -u -3 -r1.20 -r1.21 --- ewl_seeker.h 2 Mar 2007 04:39:47 -0000 1.20 +++ ewl_seeker.h 4 Mar 2007 00:52:01 -0000 1.21 @@ -47,8 +47,7 @@ #define EWL_SEEKER(seeker) ((Ewl_Seeker *) seeker) /** - * Inherits from Ewl_Container and creates internal Ewl_Widget's to provide a - * range and a draggable area to select a value from that range. + * @brief Inherits from Ewl_Range and extends to provide a seeker widget */ struct Ewl_Seeker { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_spacer.h,v retrieving revision 1.10 retrieving revision 1.11 diff -u -3 -r1.10 -r1.11 --- ewl_spacer.h 2 Mar 2007 04:39:47 -0000 1.10 +++ ewl_spacer.h 4 Mar 2007 00:52:01 -0000 1.11 @@ -36,9 +36,7 @@ typedef struct Ewl_Spacer Ewl_Spacer; /** - * Inherits from Ewl_Widget, and does not provide any further functionality, - * it is intended to be themed as transparent, and used to tweak spacing in an - * application. + * @brief Inherits from Ewl_Widget and provides as a spacer between widgets */ struct Ewl_Spacer { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_spectrum.h,v retrieving revision 1.18 retrieving revision 1.19 diff -u -3 -r1.18 -r1.19 --- ewl_spectrum.h 2 Mar 2007 04:39:47 -0000 1.18 +++ ewl_spectrum.h 4 Mar 2007 00:52:01 -0000 1.19 @@ -36,7 +36,7 @@ typedef struct Ewl_Spectrum Ewl_Spectrum; /** - * Inherits from Ewl_Overlay and extends to privide a colour spectrum + * @brief Inherits from Ewl_Overlay and extends to provide a colour spectrum */ struct Ewl_Spectrum { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_spinner.h,v retrieving revision 1.19 retrieving revision 1.20 diff -u -3 -r1.19 -r1.20 --- ewl_spinner.h 2 Mar 2007 04:39:47 -0000 1.19 +++ ewl_spinner.h 4 Mar 2007 00:52:01 -0000 1.20 @@ -45,8 +45,7 @@ #define EWL_SPINNER(spinner) ((Ewl_Spinner *) spinner) /** - * Inherits from Ewl_Range and adds an entry box that can only contain - * numerical values as well as buttons for manipulating that value. + * @brief Inherits from Ewl_Range and extends to provide a spinner widget */ struct Ewl_Spinner { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_statusbar.h,v retrieving revision 1.16 retrieving revision 1.17 diff -u -3 -r1.16 -r1.17 --- ewl_statusbar.h 2 Mar 2007 04:39:47 -0000 1.16 +++ ewl_statusbar.h 4 Mar 2007 00:52:01 -0000 1.17 @@ -43,7 +43,7 @@ #define EWL_STATUSBAR(statusbar) ((Ewl_Statusbar *) statusbar) /** - * Inherits from the Ewl_Box class and extends it to provide for + * @brief Inherits from the Ewl_Box class and extends it to provide for * a simple status bar */ struct Ewl_Statusbar =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_stock.h,v retrieving revision 1.8 retrieving revision 1.9 diff -u -3 -r1.8 -r1.9 --- ewl_stock.h 2 Mar 2007 04:39:47 -0000 1.8 +++ ewl_stock.h 4 Mar 2007 00:52:01 -0000 1.9 @@ -79,7 +79,8 @@ typedef void (*Ewl_Stock_Tooltip_Set)(Ewl_Stock *s, const char *tip); /** - * @brief An abstract Ewl_Widget to provide the base for Ewl_Icon and Ewl_Button + * @brief Inherits from Ewl_Box and provides the base for the other stock + * icons */ struct Ewl_Stock { @@ -88,6 +89,10 @@ Ewl_Stock_Funcs *stock_funcs; /**< The stock functions */ }; +/** + * @brief The function callbacks that an inheriting widget needs to + * implement + */ struct Ewl_Stock_Funcs { Ewl_Stock_Label_Set label_set; /**< The label set function */ =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_table.h,v retrieving revision 1.21 retrieving revision 1.22 diff -u -3 -r1.21 -r1.22 --- ewl_table.h 2 Mar 2007 04:39:47 -0000 1.21 +++ ewl_table.h 4 Mar 2007 00:52:01 -0000 1.22 @@ -46,7 +46,7 @@ #define EWL_TABLE(table) ((Ewl_Table *)table) /** - * Inherits from Ewl_Container and extends to provide a table layout + * @brief Inherits from Ewl_Container and extends to provide a table layout */ struct Ewl_Table { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_text.c,v retrieving revision 1.158 retrieving revision 1.159 diff -u -3 -r1.158 -r1.159 --- ewl_text.c 3 Mar 2007 01:58:19 -0000 1.158 +++ ewl_text.c 4 Mar 2007 00:52:01 -0000 1.159 @@ -5,7 +5,14 @@ #include "ewl_debug.h" #include "ewl_macros.h" +/** + * Ewl_Text_Fmt + */ typedef struct Ewl_Text_Fmt Ewl_Text_Fmt; + +/** + * @brief Text formatting information + */ struct Ewl_Text_Fmt { Ewl_Text_Context *tx; =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_text.h,v retrieving revision 1.53 retrieving revision 1.54 diff -u -3 -r1.53 -r1.54 --- ewl_text.h 2 Mar 2007 04:39:47 -0000 1.53 +++ ewl_text.h 4 Mar 2007 00:52:01 -0000 1.54 @@ -82,7 +82,7 @@ typedef struct Ewl_Text Ewl_Text; /** - * Inherits from the Ewl_Container class and extends it to provide text layout + * @brief Inherits from the Ewl_Container class and extends it to provide text layout * and formatting */ struct Ewl_Text @@ -307,7 +307,7 @@ void ewl_text_fmt_dump(Ewl_Text *t); /** - * Inherits from Ewl_Widget and extends to provide a trigger for the text + * @brief Inherits from Ewl_Widget and extends to provide a trigger for the text * widget */ struct Ewl_Text_Trigger @@ -376,7 +376,7 @@ void ewl_text_trigger_cb_mouse_down(Ewl_Widget *w, void *ev, void *data); /** - * Stores context information for the different formatting nodes + * @brief Stores context information for the different formatting nodes */ struct Ewl_Text_Context { @@ -427,7 +427,7 @@ #define EWL_TEXT_TRIGGER_AREA(area) ((Ewl_Text_Trigger_Area *) area) /** - * Inherits from Ewl_Widget and extends to provide a trigger area + * @brief Inherits from Ewl_Widget and extends to provide a trigger area */ struct Ewl_Text_Trigger_Area { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_toolbar.h,v retrieving revision 1.5 retrieving revision 1.6 diff -u -3 -r1.5 -r1.6 --- ewl_toolbar.h 2 Mar 2007 04:39:47 -0000 1.5 +++ ewl_toolbar.h 4 Mar 2007 00:52:01 -0000 1.6 @@ -38,7 +38,7 @@ #define EWL_TOOLBAR(toolbar) ((Ewl_Toolbar *) toolbar) /** - * @brief Inherits from Ewl_Toolbar + * @brief Inherits from Ewl_Menubar and extends to provide a toolbar layout */ struct Ewl_Toolbar { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_tree.h,v retrieving revision 1.27 retrieving revision 1.28 diff -u -3 -r1.27 -r1.28 --- ewl_tree.h 2 Mar 2007 04:39:47 -0000 1.27 +++ ewl_tree.h 4 Mar 2007 00:52:01 -0000 1.28 @@ -56,8 +56,7 @@ #define EWL_TREE(t) ((Ewl_Tree *)t) /** - * The tree is a columnar listing, where items in the list may be nested below - * other items. + * @brief Inherits from Ewl_Container and extends to provide a tree layout. */ struct Ewl_Tree { @@ -83,9 +82,9 @@ */ #define EWL_TREE_NODE(t) ((Ewl_Tree_Node *)t) -/* - * The tree_node exists for each row, at this level the tree_node contains rows - * that contain cells which display the data. +/** + * @brief Inherits from Ewl_Container and extends to hold information on a + * row of the tree. */ struct Ewl_Tree_Node { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_tree2.c,v retrieving revision 1.58 retrieving revision 1.59 diff -u -3 -r1.58 -r1.59 --- ewl_tree2.c 2 Mar 2007 02:33:10 -0000 1.58 +++ ewl_tree2.c 4 Mar 2007 00:52:01 -0000 1.59 @@ -13,7 +13,14 @@ #include "ewl_debug.h" #include "ewl_macros.h" +/** + * Ewl_Tree2_Branch_Cache + */ typedef struct Ewl_Tree2_Branch_Cache Ewl_Tree2_Branch_Cache; + +/** + * @brief Contains information for tree2 branches + */ struct Ewl_Tree2_Branch_Cache { Ewl_Model *model; =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_tree2.h,v retrieving revision 1.41 retrieving revision 1.42 diff -u -3 -r1.41 -r1.42 --- ewl_tree2.h 2 Mar 2007 04:39:47 -0000 1.41 +++ ewl_tree2.h 4 Mar 2007 00:52:01 -0000 1.42 @@ -89,8 +89,7 @@ typedef struct Ewl_Tree2 Ewl_Tree2; /** - * The tree is a columnar listing, where items in the list may be nested - * below other items. + * @brief Inherits from Ewl_MVC and extends to provide a tree widget. */ struct Ewl_Tree2 { @@ -169,7 +168,7 @@ typedef struct Ewl_Tree2_Column Ewl_Tree2_Column; /** - * Holdes the model and view to use for this column in the tree + * @brief Holds the model and view to use for this column in the tree */ struct Ewl_Tree2_Column { @@ -210,7 +209,16 @@ #define EWL_TREE2_NODE_IS(w) (ewl_widget_type_is(EWL_WIDGET(w), EWL_TREE2_NODE_TYPE)) #define EWL_TREE2_NODE(n) ((Ewl_Tree2_Node *)n) + +/** + * Ewl_Tree2_Node + */ typedef struct Ewl_Tree2_Node Ewl_Tree2_Node; + +/** + * @brief Inherits from Ewl_Container and extends to hold information on a + * row of the tree + */ struct Ewl_Tree2_Node { Ewl_Container container; =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_tree2_view.h,v retrieving revision 1.6 retrieving revision 1.7 diff -u -3 -r1.6 -r1.7 --- ewl_tree2_view.h 2 Mar 2007 04:39:47 -0000 1.6 +++ ewl_tree2_view.h 4 Mar 2007 00:52:01 -0000 1.7 @@ -39,7 +39,8 @@ typedef struct Ewl_Tree2_View Ewl_Tree2_View; /** - * Ewl_Tree2_View + * @brief Inherits from Ewl_Box and provides the base information for a tree + * view */ struct Ewl_Tree2_View { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_tree2_view_plain.h,v retrieving revision 1.6 retrieving revision 1.7 diff -u -3 -r1.6 -r1.7 --- ewl_tree2_view_plain.h 2 Mar 2007 04:39:47 -0000 1.6 +++ ewl_tree2_view_plain.h 4 Mar 2007 00:52:01 -0000 1.7 @@ -38,7 +38,7 @@ #define EWL_TREE2_VIEW_PLAIN(tv) ((Ewl_Tree2_View_Plain*)tv) /** - * Provides a plain view for the tree + * @brief Inherits from Ewl_Tree2_View and provides a plain tree layout */ struct Ewl_Tree2_View_Plain { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_tree2_view_scrolled.h,v retrieving revision 1.6 retrieving revision 1.7 diff -u -3 -r1.6 -r1.7 --- ewl_tree2_view_scrolled.h 2 Mar 2007 04:39:47 -0000 1.6 +++ ewl_tree2_view_scrolled.h 4 Mar 2007 00:52:01 -0000 1.7 @@ -38,7 +38,7 @@ #define EWL_TREE2_VIEW_SCROLLED(tv) ((Ewl_Tree2_View_Scrolled*)tv) /** - * A scrolled view on the tree + * @brief Inherits from Ewl_Box and provides a scrolled tree layout */ struct Ewl_Tree2_View_Scrolled { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_view.h,v retrieving revision 1.10 retrieving revision 1.11 diff -u -3 -r1.10 -r1.11 --- ewl_view.h 6 Feb 2007 10:56:09 -0000 1.10 +++ ewl_view.h 4 Mar 2007 00:52:01 -0000 1.11 @@ -56,7 +56,7 @@ typedef struct Ewl_View Ewl_View; /** - * The view function pointers + * @brief The view function pointers */ struct Ewl_View { =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_widget.h,v retrieving revision 1.58 retrieving revision 1.59 diff -u -3 -r1.58 -r1.59 --- ewl_widget.h 3 Mar 2007 00:22:54 -0000 1.58 +++ ewl_widget.h 4 Mar 2007 00:52:01 -0000 1.59 @@ -35,7 +35,7 @@ typedef struct Ewl_Attach_List Ewl_Attach_List; /** - * A list of things attached to a widget + * @brief A list of things attached to a widget */ struct Ewl_Attach_List { @@ -56,7 +56,7 @@ #define EWL_PAIR(p) ((Ewl_Pair *)p) /** - * Contains a key and a value pair + * @brief Contains a key and a value pair */ struct Ewl_Pair { @@ -70,7 +70,7 @@ typedef struct Ewl_Pair_List Ewl_Pair_List; /** - * Contains a list of key value pairs + * @brief Contains a list of key value pairs */ struct Ewl_Pair_List { @@ -85,7 +85,7 @@ typedef struct Ewl_Callback_Chain Ewl_Callback_Chain; /** - * The callback chain contains the length, mask and information on the list + * @brief The callback chain contains the length, mask and information on the list */ struct Ewl_Callback_Chain { @@ -101,7 +101,7 @@ typedef struct Ewl_Color_Set Ewl_Color_Set; /** - * Contains an RGBA set of colours + * @brief Contains an RGBA set of colours */ struct Ewl_Color_Set { @@ -129,7 +129,7 @@ #define EWL_WIDGET(widget) ((Ewl_Widget *) widget) /** - * The class inheriting from Ewl_Object that provides appearance, parent, and + * @brief Inherits from Ewl_Object and extends to provide appearance, parent, and * callback capabilities. */ struct Ewl_Widget =================================================================== RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_window.h,v retrieving revision 1.30 retrieving revision 1.31 diff -u -3 -r1.30 -r1.31 --- ewl_window.h 2 Mar 2007 04:39:47 -0000 1.30 +++ ewl_window.h 4 Mar 2007 00:52:01 -0000 1.31 @@ -43,7 +43,7 @@ #define EWL_WINDOW(win) ((Ewl_Window *) win) /** - * Extends the Ewl_Embed class to create it's own window and evas for drawing, + * @brief Inherits from Ewl_Embed class to create it's own window and canvas for drawing, * sizing and positioning. */ struct Ewl_Window ------------------------------------------------------------------------- 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