Enlightenment CVS committal
Author : dj2
Project : e17
Module : libs/ewl
Dir : e17/libs/ewl/src/lib
Modified Files:
ewl_attach.h ewl_border.h ewl_box.h ewl_button.h
ewl_calendar.h ewl_cell.h ewl_check.h ewl_checkbutton.h
ewl_colordialog.h ewl_colorpicker.h ewl_combo.h ewl_config.h
ewl_container.h ewl_datepicker.h ewl_dialog.h ewl_dnd.c
ewl_dnd.h ewl_embed.c ewl_embed.h ewl_entry.c ewl_entry.h
Log Message:
- documentation cleanups/fixes
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_attach.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -3 -r1.7 -r1.8
--- ewl_attach.h 15 Feb 2006 16:57:20 -0000 1.7
+++ ewl_attach.h 16 Feb 2006 17:06:43 -0000 1.8
@@ -22,7 +22,6 @@
typedef struct Ewl_Attach Ewl_Attach;
/**
- * @struct Ewl_Attach
* Contains the attachment information
*/
struct Ewl_Attach
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_border.h,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -3 -r1.6 -r1.7
--- ewl_border.h 15 Feb 2006 16:52:18 -0000 1.6
+++ ewl_border.h 16 Feb 2006 17:06:43 -0000 1.7
@@ -28,7 +28,6 @@
#define EWL_BORDER(border) ((Ewl_Border *) border)
/**
- * @struct Ewl_Border
* @brief Inherits from Ewl_Container to allow drawing a border and label
* decoration around widgets.
*/
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_box.h,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -3 -r1.9 -r1.10
--- ewl_box.h 15 Feb 2006 17:40:49 -0000 1.9
+++ ewl_box.h 16 Feb 2006 17:06:43 -0000 1.10
@@ -29,7 +29,6 @@
#define EWL_BOX(box) ((Ewl_Box *) box)
/**
- * @struct Ewl_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,
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_button.h,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -3 -r1.10 -r1.11
--- ewl_button.h 15 Feb 2006 17:40:49 -0000 1.10
+++ ewl_button.h 16 Feb 2006 17:06:43 -0000 1.11
@@ -29,7 +29,6 @@
#define EWL_BUTTON(button) ((Ewl_Button *) button)
/**
- * @struct Ewl_Button
* @brief A simple Ewl_Widget to provide for a clickable button in the UI.
* Provides easy facilities for adding a Ewl_Text label to the button, and
* a Ewl_Image but allows for placing any number of Ewl_Widget's in the
Ewl_Button.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_calendar.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -3 -r1.8 -r1.9
--- ewl_calendar.h 15 Feb 2006 17:40:49 -0000 1.8
+++ ewl_calendar.h 16 Feb 2006 17:06:43 -0000 1.9
@@ -27,7 +27,6 @@
#define EWL_CALENDAR(calendar) ((Ewl_Calendar *) calendar)
/**
- * @struct Ewl_Calendar
* Inherits from an Ewl_Box to provide a calendar widget
* Layout is either free-form, or auto-arranged to a grid.
*/
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_cell.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- ewl_cell.h 15 Feb 2006 17:40:49 -0000 1.5
+++ ewl_cell.h 16 Feb 2006 17:06:43 -0000 1.6
@@ -24,7 +24,6 @@
#define EWL_CELL(t) ((Ewl_Cell *)t)
/**
- * @struct Ewl_Cell
* The cell inherits from the container for packing widgets inside the
* cell.
*/
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_check.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -3 -r1.7 -r1.8
--- ewl_check.h 15 Feb 2006 17:40:49 -0000 1.7
+++ ewl_check.h 16 Feb 2006 17:06:43 -0000 1.8
@@ -30,7 +30,6 @@
#define EWL_CHECK(c) ((Ewl_Check *)c)
/**
- * @struct Ewl_Check
* Inherits from Ewl_Check and extends it to provide a checked state.
*/
struct Ewl_Check
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_checkbutton.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -3 -r1.8 -r1.9
--- ewl_checkbutton.h 15 Feb 2006 17:53:25 -0000 1.8
+++ ewl_checkbutton.h 16 Feb 2006 17:06:43 -0000 1.9
@@ -29,7 +29,6 @@
#define EWL_CHECKBUTTON(button) ((Ewl_Checkbutton *) button)
/**
- * @struct Ewl_Checkbutton
* Inherits from Ewl_Widget and expands to provide a stateful check button.
*/
struct Ewl_Checkbutton
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_colordialog.h,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -3 -r1.10 -r1.11
--- ewl_colordialog.h 15 Feb 2006 18:25:05 -0000 1.10
+++ ewl_colordialog.h 16 Feb 2006 17:06:43 -0000 1.11
@@ -21,7 +21,6 @@
typedef struct Ewl_Colordialog Ewl_Colordialog;
/**
- * @struct Ewl_Colordialog
* Inherit from the Ewl_Dialog to create a color dialog widget
*/
struct Ewl_Colordialog
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_colorpicker.h,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -3 -r1.13 -r1.14
--- ewl_colorpicker.h 15 Feb 2006 20:04:59 -0000 1.13
+++ ewl_colorpicker.h 16 Feb 2006 17:06:43 -0000 1.14
@@ -21,7 +21,6 @@
typedef struct Ewl_Colorpicker Ewl_Colorpicker;
/**
- * @struct Ewl_Colorpicker
* This inherits from Ewl_Box to produce a color picker widget
*/
struct Ewl_Colorpicker
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_combo.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -3 -r1.8 -r1.9
--- ewl_combo.h 15 Feb 2006 20:29:47 -0000 1.8
+++ ewl_combo.h 16 Feb 2006 17:06:43 -0000 1.9
@@ -29,7 +29,6 @@
#define EWL_COMBO(combo) ((Ewl_Combo *) combo)
/**
- * @struct Ewl_Combo
* Inherits from the Ewl_Menu_Base and does not extend the structure, but
* provides policy for drawing on the current evas.
*/
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_config.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -3 -r1.8 -r1.9
--- ewl_config.h 15 Feb 2006 20:29:47 -0000 1.8
+++ ewl_config.h 16 Feb 2006 17:06:43 -0000 1.9
@@ -10,7 +10,6 @@
typedef struct Ewl_Config Ewl_Config;
/**
- * @struct Ewl_Config
* The Ewl_Config stuct holds configuration data for the EWL library
*/
struct Ewl_Config
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_container.h,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -3 -r1.17 -r1.18
--- ewl_container.h 15 Feb 2006 21:25:01 -0000 1.17
+++ ewl_container.h 16 Feb 2006 17:06:43 -0000 1.18
@@ -68,7 +68,6 @@
typedef Ewl_Widget *(*Ewl_Container_Iterator) (Ewl_Container *c);
/**
- * @struct Ewl_Container
* Inherits from the Ewl_Widget and expands to allow for placing child widgets
* within the available space. Also adds notifiers for various child events.
*/
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_datepicker.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- ewl_datepicker.h 15 Feb 2006 21:25:01 -0000 1.5
+++ ewl_datepicker.h 16 Feb 2006 17:06:43 -0000 1.6
@@ -27,7 +27,6 @@
#define EWL_DATEPICKER(datepicker) ((Ewl_Datepicker *) datepicker)
/**
- * @struct Ewl_Datepicker
* Inherits from an Ewl_Text
*/
struct Ewl_Datepicker
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_dialog.h,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -3 -r1.9 -r1.10
--- ewl_dialog.h 15 Feb 2006 21:25:01 -0000 1.9
+++ ewl_dialog.h 16 Feb 2006 17:06:43 -0000 1.10
@@ -29,7 +29,6 @@
#define EWL_DIALOG(dialog) ((Ewl_Dialog *) dialog)
/**
- * @struct Ewl_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.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_dnd.c,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -3 -r1.8 -r1.9
--- ewl_dnd.c 12 Jan 2006 18:21:18 -0000 1.8
+++ ewl_dnd.c 16 Feb 2006 17:06:43 -0000 1.9
@@ -31,6 +31,7 @@
/**
* @return Returns TRUE if the DND system was successfully initialized,
* FALSE otherwise
+ * @brief Initialize the DND sybsystem
*/
int
ewl_dnd_init(void)
@@ -48,6 +49,7 @@
}
/**
+ * @return Returns no value.
* @brief Shuts down the EWL DND system
*/
void
@@ -80,6 +82,7 @@
/**
* @param widget: The widget to get the types for
* @return Returns the Ewl_Dnd_Types for the given widget
+ * @brief Get the Ewl_Dnd_Types for the given widget
*/
Ewl_Dnd_Types *
ewl_dnd_types_for_widget_get(Ewl_Widget *widget)
@@ -108,6 +111,7 @@
/**
* @param: The widget to start dragging
* @return Returns no value
+ * @brief Tells the widget to start dragging
*/
void
ewl_drag_start(Ewl_Widget *w)
@@ -142,7 +146,7 @@
ecore_x_window_resize(ewl_dnd_evas_win, 64, 64);
ecore_evas_override_set(ewl_dnd_drag_canvas, 1);
- //ecore_evas_software_x11_direct_resize_set(ewl_dnd_drag_evas, 1);
+ /* ecore_evas_software_x11_direct_resize_set(ewl_dnd_drag_evas, 1); */
ecore_evas_ignore_events_set(ewl_dnd_drag_canvas, 1);
/* XXX Setup a cursor (This needs to become generic) */
@@ -178,8 +182,8 @@
}
/**
- * @brief Disables DND
* @return Returns no value
+ * @brief Disables DND
*/
void
ewl_dnd_disable(void)
@@ -192,8 +196,8 @@
}
/**
- * @brief Enables DND
* @return Returns no value
+ * @brief Enables DND
*/
void
ewl_dnd_enable(void)
@@ -207,6 +211,7 @@
/**
* @return Returns the current DND status
+ * @brief Retrieves the current DND status
*/
int
ewl_dnd_status_get(void)
@@ -218,6 +223,7 @@
/**
* @return Returns the current DND widget
+ * @brief Retrieves the current DND widget
*/
Ewl_Widget *
ewl_dnd_drag_widget_get(void)
@@ -228,6 +234,7 @@
}
/**
+ * @return Returns no value.
* @brief Clears the current DND widget
*/
void
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_dnd.h,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -3 -r1.9 -r1.10
--- ewl_dnd.h 29 Dec 2005 17:45:01 -0000 1.9
+++ ewl_dnd.h 16 Feb 2006 17:06:43 -0000 1.10
@@ -1,9 +1,8 @@
-#ifndef __EWL_DND_H__
-#define __EWL_DND_H__
+#ifndef EWL_DND_H
+#define EWL_DND_H
/**
- * @file ewl_dnd.h
- * @defgroup Ewl_Dnd Dnd: The files containing DND functions
+ * @defgroup Ewl_Dnd Ewl_Dnd: The files containing DND functions
*
* @{
*/
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_embed.c,v
retrieving revision 1.47
retrieving revision 1.48
diff -u -3 -r1.47 -r1.48
--- ewl_embed.c 31 Jan 2006 14:45:01 -0000 1.47
+++ ewl_embed.c 16 Feb 2006 17:06:43 -0000 1.48
@@ -238,6 +238,7 @@
* @param embed: The embed to set the active value on
* @param act: The active value to set
* @return Returns no value.
+ * @brief Sets if the given embed @p embed is active or not
*/
void
ewl_embed_active_set(Ewl_Embed *embed, unsigned int act)
@@ -298,6 +299,7 @@
/**
* @return Returns the currently active embed
+ * @brief Returns the currently active embed widget
*/
Ewl_Embed *
ewl_embed_active_embed_get(void)
@@ -1358,6 +1360,7 @@
* @param embed: The embed to set the focused widget too
* @param w: The widget to set as having focus
* @return Returns no value.
+ * @brief Set the current focused widget in the embed
*/
void
ewl_embed_focused_widget_set(Ewl_Embed *embed, Ewl_Widget *w)
@@ -1386,6 +1389,7 @@
/**
* @param embed: The embed to get the curerntly focused widget
* @return Returns the currently focused widget
+ * @brief Get the current focused widget in the embed.
*/
Ewl_Widget *
ewl_embed_focused_widget_get(Ewl_Embed *embed)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_embed.h,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -3 -r1.13 -r1.14
--- ewl_embed.h 31 Jan 2006 05:11:59 -0000 1.13
+++ ewl_embed.h 16 Feb 2006 17:06:43 -0000 1.14
@@ -1,9 +1,8 @@
-#ifndef __EWL_EMBED_H__
-#define __EWL_EMBED_H__
+#ifndef EWL_EMBED_H
+#define EWL_EMBED_H
/**
- * @file ewl_embed.h
- * @defgroup Ewl_Embed Embed: A Container for Displaying on an Evas
+ * @defgroup Ewl_Embed Ewl_Embed: A Container for Displaying on an Evas
* Defines the Ewl_Embed class to provide EWL with the ability to work with an
* evas.
*
@@ -41,7 +40,6 @@
#define EWL_EMBED_EVAS_WINDOW(window) ((Ewl_Embed_Evas_Window *)window)
/**
- * @struct Ewl_Embed
* @brief The class inheriting from Ewl_Container that acts as a top level
* widget for interacting with the evas.
*/
@@ -63,12 +61,12 @@
struct
{
- Ewl_Widget *clicked;
- Ewl_Widget *focused;
- Ewl_Widget *mouse_in;
- } last;
+ Ewl_Widget *clicked; /**< Last clicked widget */
+ Ewl_Widget *focused; /**< Last focused widget */
+ Ewl_Widget *mouse_in; /**< Last widget to receive a mouse_in */
+ } last; /**< Collection of widgets to last receive
events */
- Ewl_Widget *dnd_widget;
+ Ewl_Widget *dnd_widget; /**< The current DND widget */
};
Ewl_Widget *ewl_embed_new(void);
@@ -97,7 +95,6 @@
unsigned int modifiers);
void ewl_embed_dnd_position_feed(Ewl_Embed *embed, int x, int
y,int*,int*,int*,int*);
-void ewl_embed_dnd_enter_feed(Ewl_Embed *embed, int x, int y, void*
dnd_event);
void ewl_embed_dnd_drop_feed(Ewl_Embed* , int x, int y, int
internal);
void ewl_embed_mouse_out_feed(Ewl_Embed *embed, int x, int y,
@@ -145,4 +142,4 @@
* @}
*/
-#endif /* __EWL_EMBED_H__ */
+#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_entry.c,v
retrieving revision 1.46
retrieving revision 1.47
diff -u -3 -r1.46 -r1.47
--- ewl_entry.c 31 Jan 2006 05:11:59 -0000 1.46
+++ ewl_entry.c 16 Feb 2006 17:06:43 -0000 1.47
@@ -6,6 +6,7 @@
/**
* @param text: The text to set into the entry
* @return Returns a new Ewl_Widget on success or NULL on failure
+ * @brief Create and return a new Ewl_Entry widget
*/
Ewl_Widget *
ewl_entry_new(void)
@@ -32,6 +33,7 @@
* @param e: The Ewl_Entry to initialize
* @param text: The text to put into the entry
* @return Returns TRUE on success or FALSE on failure
+ * @brief Initializes an Ewl_Entry widget to default values
*/
int
ewl_entry_init(Ewl_Entry *e)
@@ -91,6 +93,7 @@
* @param e: The Ewl_Entry to set the multiline status
* @param multiline: The multiline status to set
* @return Returns no value
+ * @brief Set if the entry is multiline or not
*/
void
ewl_entry_multiline_set(Ewl_Entry *e, unsigned int multiline)
@@ -107,9 +110,10 @@
/**
* @param e: The Ewl_Entry to get the multiline status from
* @return Returns the multline status of the widget
+ * @brief Retrieve if the entry is multiline or not
*/
unsigned int
-ewl_entry_multline_get(Ewl_Entry *e)
+ewl_entry_multiline_get(Ewl_Entry *e)
{
DENTER_FUNCTION(DLEVEL_STABLE);
DCHECK_PARAM_PTR_RET("e", e, 0);
@@ -122,6 +126,7 @@
* @param e: The Ewl_Entry to set the editable status of
* @param editable: The value to set for the editable flag
* @return Returns no value
+ * @brief Set if the entry is editable or not
*/
void
ewl_entry_editable_set(Ewl_Entry *e, unsigned int editable)
@@ -164,6 +169,7 @@
/**
* @param e: The Ewl_Entry to get the editable status from
* @return Returns the editable status of the entry
+ * @brief Retrieve if the entry is editable or not
*/
unsigned int
ewl_entry_editable_get(Ewl_Entry *e)
@@ -178,6 +184,7 @@
/**
* @param e: The entry to clear the selection of
* @return Returns TRUE if a selection was cleared, FALSE otherwise.
+ * @brief Clear the current selection in the entry
*/
unsigned int
ewl_entry_selection_clear(Ewl_Entry *e)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_entry.h,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -3 -r1.16 -r1.17
--- ewl_entry.h 12 Jan 2006 18:21:18 -0000 1.16
+++ ewl_entry.h 16 Feb 2006 17:06:43 -0000 1.17
@@ -1,20 +1,38 @@
-#ifndef __EWL_ENTRY_H__
-#define __EWL_ENTRY_H__
+#ifndef EWL_ENTRY_H
+#define EWL_ENTRY_H
+
+/**
+ * @defgroup Ewl_Entry Ewl_Entry: A text entry widget
+ * This widget provides all text entry needs, from single to multiline
+ *
+ * @{
+ */
#define EWL_ENTRY_TYPE "entry"
#define EWL_CURSOR_TYPE "cursor"
+/**
+ * @def EWL_ENTRY(entry)
+ * Typecast a pointer to an Ewl_Entry
+ */
#define EWL_ENTRY(entry) ((Ewl_Entry *) entry)
+/**
+ * The Ewl_Entry
+ */
typedef struct Ewl_Entry Ewl_Entry;
+
+/**
+ * Inherits from Ewl_Text and extends to allow editing of the text
+ */
struct Ewl_Entry
{
- Ewl_Text text;
- Ewl_Widget *cursor;
+ Ewl_Text text; /**< The Ewl_Text parent */
+ Ewl_Widget *cursor; /**< The cursor */
- unsigned int multiline;
- unsigned int editable;
- unsigned int in_select_mode;
+ unsigned int multiline; /**< Is the entry multi-line */
+ unsigned int editable; /**< Is the entry editable */
+ unsigned int in_select_mode; /**< Are we in select mode */
};
Ewl_Widget *ewl_entry_new(void);
@@ -63,5 +81,9 @@
void ewl_entry_cursor_position_set(Ewl_Entry_Cursor *c, unsigned
int pos);
unsigned int ewl_entry_cursor_position_get(Ewl_Entry_Cursor *c);
-#endif /* __EWL_ENTRY_H__ */
+/**
+ * @}
+ */
+
+#endif
-------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc. Do you grep through log files
for problems? Stop! Download the new AJAX search engine that makes
searching your log files as easy as surfing the web. DOWNLOAD SPLUNK!
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=103432&bid=230486&dat=121642
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
