Enlightenment CVS committal
Author : rbdpngn
Project : e17
Module : libs/ewl
Dir : e17/libs/ewl/src
Modified Files:
ewl_box.h ewl_button.h ewl_callback.c ewl_callback.h
ewl_cell.c ewl_cell.h ewl_check.c ewl_check.h
ewl_checkbutton.h ewl_container.h ewl_embed.h ewl_entry.h
ewl_floater.h ewl_macros.h ewl_menu_base.h ewl_object.h
ewl_seeker.h ewl_separator.h ewl_spacer.h ewl_text.h
ewl_textarea.h ewl_theme.h ewl_tree.h ewl_widget.h
ewl_window.h
Log Message:
Documented a couple more widgets and converted the docs to display
groups/modules rather than the header file list.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_box.h,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -3 -r1.22 -r1.23
--- ewl_box.h 27 Aug 2003 22:00:11 -0000 1.22
+++ ewl_box.h 1 Sep 2003 04:57:07 -0000 1.23
@@ -3,9 +3,11 @@
#define __EWL_BOX_H__
/**
- * @file ewl_box.h
- * Defines the Ewl_Box class used for laying out Ewl_Widget's in a horizontal
- * or vertical line.
+ * @defgroup Ewl_Box The Box Layout Widget.
+ * @brief Defines the Ewl_Box class used for laying out Ewl_Widget's in a
+ * horizontal or vertical line.
+ *
+ * @{
*/
/**
@@ -55,5 +57,9 @@
void ewl_box_set_orientation(Ewl_Box * b, Ewl_Orientation o);
void ewl_box_set_spacing(Ewl_Box * b, int spacing);
void ewl_box_set_homogeneous(Ewl_Box *b, int h);
+
+/**
+ * @}
+ */
#endif /* __EWL_BOX_H__ */
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_button.h,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -3 -r1.17 -r1.18
--- ewl_button.h 27 Aug 2003 22:00:12 -0000 1.17
+++ ewl_button.h 1 Sep 2003 04:57:07 -0000 1.18
@@ -2,9 +2,11 @@
#define __EWL_BUTTON_H__
/**
- * @file ewl_button.h
- * The button class is a basic button with a label. This class inherits from
- * the Ewl_Box to allow for placing any other widget inside the button.
+ * @defgroup Ewl_Button The Basic Button
+ * @brief The button class is a basic button with a label. This class inherits
+ * from the Ewl_Box to allow for placing any other widget inside the button.
+ *
+ * @{
*/
/**
@@ -34,5 +36,9 @@
Ewl_Widget *ewl_button_new(char *l);
void ewl_button_init(Ewl_Button * b, char *label);
void ewl_button_set_label(Ewl_Button * b, char *l);
+
+/**
+ * @}
+ */
#endif /* __EWL_BUTTON_H__ */
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_callback.c,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -3 -r1.31 -r1.32
--- ewl_callback.c 4 Apr 2003 04:55:51 -0000 1.31
+++ ewl_callback.c 1 Sep 2003 04:57:07 -0000 1.32
@@ -9,10 +9,11 @@
static Ewd_Hash *cb_registration = NULL;
/**
- * ewl_callbacks_init - setup internal registration variables for callbacks
+ * @return Returns no value.
+ * @brief Setup internal registration variables for callbacks
*
- * Returns no value. Sets up some important variables for tracking callbacks
- * that allow shared callbacks.
+ * Sets up some important variables for tracking callbacks that allow shared
+ * callbacks.
*
* W/o shared callbacks ewl_test with all windows open has a top line of:
* 21279 ningerso 19 0 22972 22M 9412 R 6.0 8.0 0:40 ewl_test
@@ -28,10 +29,11 @@
}
/**
- * ewl_callbacks_deinit - destroy internal registration variables for callbacks
+ * @return Returns no value.
+ * @brief Destroy internal registration variables for callbacks
*
- * Returns no value. Destroys some important variables for tracking callbacks
- * that allow shared callbacks.
+ * Destroys some important variables for tracking callbacks that allow shared
+ * callbacks.
*/
void ewl_callbacks_deinit()
{
@@ -91,16 +93,16 @@
}
/**
- * ewl_callback_append - append a callback of the specified type
- * @w: the widget to attach the callback
- * @t: the type of the callback that is being attached
- * @f: the function to attach as a callback
- * @user_data: the data to be passed to the callback function
- *
- * Returns 0 on failure, the id of the new callback on success. Allocates a
- * new callback for the specified widget that calls @f with @user_data as the
- * data parameter when event @t occurs. This event is placed at the end of the
- * callback chain.
+ * @param w: the widget to attach the callback
+ * @param t: the type of the callback that is being attached
+ * @param f: the function to attach as a callback
+ * @param user_data: the data to be passed to the callback function
+ * @return Returns 0 on failure, the id of the new callback on success.
+ * @brief Append a callback of the specified type
+ *
+ * Allocates a new callback for the specified widget that calls @a f with @a
+ * user_data as the data parameter when event @a ta occurs. This event is
+ * placed at the end of the callback chain.
*/
int
ewl_callback_append(Ewl_Widget * w, Ewl_Callback_Type t,
@@ -136,14 +138,14 @@
}
/**
- * ewl_callback_prepend - prepend a callback of the specified type
- * @w: the widget to attach the callback
- * @t: the type of the callback that is being attached
- * @f: the function to attach as a callback
- * @user_data: the data to be passed to the callback function
+ * @param w: the widget to attach the callback
+ * @param t: the type of the callback that is being attached
+ * @param f: the function to attach as a callback
+ * @param user_data: the data to be passed to the callback function
+ * @return Returns 0 on failure, the id of the new callback on success.
+ * @brief prepend a callback of the specified type
*
- * Returns 0 on failure, the id of the new callback on success. Same
- * functionality as ewl_callback_append, but the callback is placed at the
+ * Same functionality as ewl_callback_append, but the callback is placed at the
* beginning of the callback chain.
*/
int
@@ -180,17 +182,17 @@
}
/**
- * ewl_callback_insert_after - add a callback after a previous callback in list
- * @w: the widget to insert the callback
- * @t: the type of the callback that is being attached
- * @f: the function to attach as a callback
- * @user_data: the data to be passed to the callback function
- * @after: the function of the callback to append after
- * @after_data: the user data of the callback to append after
- *
- * Returns 0 on failure, the id of the new callback on success. Same
- * functionality as ewl_callback_append, but the callback is placed after the
- * specified callback on the callback chain.
+ * @param w: the widget to insert the callback
+ * @param t: the type of the callback that is being attached
+ * @param f: the function to attach as a callback
+ * @param user_data: the data to be passed to the callback function
+ * @param after: the function of the callback to append after
+ * @param after_data: the user data of the callback to append after
+ * @return Returns 0 on failure, the id of the new callback on success.
+ * @brief Add a callback after a previous callback in list
+ *
+ * Same functionality as ewl_callback_append, but the callback is placed after
+ * the specified callback on the callback chain.
*/
int
ewl_callback_insert_after(Ewl_Widget * w, Ewl_Callback_Type t,
@@ -236,12 +238,12 @@
}
/**
- * ewl_callback_call - execute callbacks of specified types for the widget
- * @w: the widget to execute the callbacks
- * @t: the type of the callbacks to be executed
+ * @param w: the widget to execute the callbacks
+ * @param t: the type of the callbacks to be executed
+ * @return Returns no value.
+ * @brief Execute callbacks of specified types for the widget
*
- * Returns no value. Executes the callback chain for the specified widget @w,
- * with event @t.
+ * Executes the callback chain for the specified widget @a w, with event @a t.
*/
void ewl_callback_call(Ewl_Widget * w, Ewl_Callback_Type t)
{
@@ -253,13 +255,14 @@
}
/**
- * ewl_callback_call_with_event_data - execute callbacks with event data
- * @w: the widget to execute the callbacks
- * @t: the type of the callbacks to be executed
- * @ev_data: the event data to pass to the callbacks
+ * @param w: the widget to execute the callbacks
+ * @param t: the type of the callbacks to be executed
+ * @param ev_data: the event data to pass to the callbacks
+ * @return Returns no value.
+ * @brief Execute callbacks with event data
*
- * Returns no value. Similar to ewl_callback_call, but the event data is
- * substituted by @ev_data.
+ * Similar to ewl_callback_call, but the event data is substituted by @a
+ * ev_data.
*/
void
ewl_callback_call_with_event_data(Ewl_Widget * w, Ewl_Callback_Type t,
@@ -323,11 +326,12 @@
}
/**
- * ewl_callback_del_type - delete all callbacks of the specified type
- * @w: the widget to delete the callbacks
- * @t: the type of the callbacks to be deleted
+ * @param w: the widget to delete the callbacks
+ * @param t: the type of the callbacks to be deleted
+ * @return Returns no value.
+ * @brief Delete all callbacks of the specified type
*
- * Returns no value. Delete all callbacks of type @t from widget @w.
+ * Delete all callbacks of type @a t from widget @a w.
*/
void ewl_callback_del_type(Ewl_Widget * w, Ewl_Callback_Type t)
{
@@ -352,12 +356,13 @@
}
/**
- * ewl_callback_del_cb_id - delete the specified callback id from the widget
- * @w: the widget to delete the id
- * @t: the type of event the callback is attached to
- * @cb_id: the id of the callback to delete
+ * @param w: the widget to delete the id
+ * @param t: the type of event the callback is attached to
+ * @param cb_id: the id of the callback to delete
+ * @return Returns no value.
+ * @brief Delete the specified callback id from the widget
*
- * Returns no value. Delete the specified callback id from the widget @w.
+ * Delete the specified callback id from the widget @a w.
*/
void ewl_callback_del_cb_id(Ewl_Widget * w, Ewl_Callback_Type t, int cb_id)
{
@@ -386,11 +391,11 @@
/**
- * ewl_callback_clear - remove all callbacks from the specified widget
- * @w: the widget to remove the callbacks
+ * @param w: the widget to remove the callbacks
+ * @return Returns no value.
+ * @brief Remove all callbacks from the specified widget
*
- * Returns no value. Removes and frees all callbacks associated with widget
- * @w.
+ * Removes and frees all callbacks associated with widget @a w.
*/
void ewl_callback_clear(Ewl_Widget * w)
{
@@ -409,13 +414,14 @@
}
/**
- * ewl_callback_del - delete the specified callback function from the widget
- * @w: the widget to delete the callback
- * @t: the type of event associated with the callback
- * @f: the function called by the callback
- *
- * Returns no value. Delete and frees the callback that calls function @f when
- * event @t occurs to widget @w.
+ * @param w: the widget to delete the callback
+ * @param t: the type of event associated with the callback
+ * @param f: the function called by the callback
+ * @brief Delete the specified callback function from the widget
+ *
+ * @return Returns no value.
+ * Delete and frees the callback that calls function @a f when event @a t occurs
+ * to widget @a w.
*/
void
ewl_callback_del(Ewl_Widget * w, Ewl_Callback_Type t, Ewl_Callback_Function f)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_callback.h,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -3 -r1.23 -r1.24
--- ewl_callback.h 14 Apr 2003 17:12:47 -0000 1.23
+++ ewl_callback.h 1 Sep 2003 04:57:07 -0000 1.24
@@ -2,14 +2,22 @@
#ifndef __EWL_CALLBACK_H__
#define __EWL_CALLBACK_H__
-typedef struct _ewl_callback Ewl_Callback;
+/**
+ * @defgroup Ewl_Callback The Callback Mechanisms
+ * Defines methods for creating and modifying callbacks on widgets
+ *
+ * @{
+ */
+
+typedef struct Ewl_Callback Ewl_Callback;
#define EWL_CALLBACK(callback) ((Ewl_Callback *) callback)
#define EWL_CALLBACK_FUNCTION(cb_func) ((Ewl_Callback_Function) cb_func)
typedef void (*Ewl_Callback_Function) (Ewl_Widget * widget, void *ev_data,
void *user_data);
-struct _ewl_callback {
+struct Ewl_Callback
+{
/*
* The function to be executed when the specified event occurs.
*/
@@ -73,5 +81,9 @@
void ewl_callback_del_type(Ewl_Widget * w, Ewl_Callback_Type t);
void ewl_callback_del(Ewl_Widget * w, Ewl_Callback_Type t,
Ewl_Callback_Function f);
+
+/**
+ * @}
+ */
#endif /* __EWL_CALLBACK_H__ */
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_cell.c,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -3 -r1.7 -r1.8
--- ewl_cell.c 25 Aug 2003 19:40:42 -0000 1.7
+++ ewl_cell.c 1 Sep 2003 04:57:07 -0000 1.8
@@ -8,9 +8,8 @@
Ewl_Orientation o);
/**
- * ewl_cell_new - allocate and initialize a new cell
- *
- * Returns a newly allocated cell on success, NULL on failure.
+ * @return Returns a newly allocated cell on success, NULL on failure.
+ * @brief Allocate and initialize a new cell
*/
Ewl_Widget *ewl_cell_new()
{
@@ -32,11 +31,11 @@
}
/**
- * ewl_cell_init - initialize the cell fields of an inheriting object
- * @cell: the cell object to initialize
+ * @param cell: the cell object to initialize
+ * @return Returns TRUE on success, FALSE on failure.
+ * @brief Initialize the cell fields of an inheriting object
*
- * Returns TRUE on success, FALSE on failure. The fields of the @cell object
- * are initialized to their defaults.
+ * The fields of the @a cell object are initialized to their defaults.
*/
int ewl_cell_init(Ewl_Cell *cell)
{
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_cell.h,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ewl_cell.h 2 Feb 2003 21:03:23 -0000 1.1
+++ ewl_cell.h 1 Sep 2003 04:57:07 -0000 1.2
@@ -1,14 +1,23 @@
#ifndef _EWL_CELL_H
#define _EWL_CELL_H
+/**
+ * @defgroup Ewl_Cell The Cell Container, Layout for a Single Widget
+ * Defines a container to layout a single child with all of it's available
+ * space.
+ *
+ * @{
+ */
+
typedef struct _ewl_cell Ewl_Cell;
#define EWL_CELL(t) ((Ewl_Cell *)t)
-/*
+/**
+ * @struct Ewl_Cell
* The cell inherits from the container for packing widgets inside the
* cell.
*/
-struct _ewl_cell
+struct Ewl_Cell
{
Ewl_Container container;
int col, row;
@@ -16,5 +25,9 @@
Ewl_Widget *ewl_cell_new();
int ewl_cell_init(Ewl_Cell *cell);
+
+/**
+ * @}
+ */
#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_check.c,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- ewl_check.c 16 Jul 2003 20:31:20 -0000 1.5
+++ ewl_check.c 1 Sep 2003 04:57:07 -0000 1.6
@@ -11,10 +11,8 @@
/**
- * ewl_check_new - allocate and initialize a new check
- * @label: the label to display with the check, NULL for no label
- *
- * Returns the newly allocated check on success, NULL on failure.
+ * @return Returns the newly allocated check on success, NULL on failure.
+ * @brief Allocate and initialize a new check
*/
Ewl_Widget *ewl_check_new()
{
@@ -33,12 +31,13 @@
}
/**
- * ewl_check_set_checked - change the checked status of the check
- * @w: the check to change the status
- * @c: the new status of the check
+ * @param cb: the check to change the status
+ * @param c: the new status of the check
+ * @return Returns no value.
+ * @brief Change the checked status of the check
*
- * Returns no value. Changes the checked status of the check and
- * updates it's appearance to reflect the change.
+ * Changes the checked status of the check and updates it's appearance to
+ * reflect the change.
*/
void ewl_check_set_checked(Ewl_Check * cb, int c)
{
@@ -56,10 +55,9 @@
}
/**
- * ewl_check_is_checked - determine the check state of the check
- * @w: the check to examine for it's checked state
- *
- * Returns TRUE if the check is checked, FALSE if not.
+ * @param cb: the check to examine for it's checked state
+ * @return Returns TRUE if the check is checked, FALSE if not.
+ * @brief Determine the check state of the check
*/
int ewl_check_is_checked(Ewl_Check * cb)
{
@@ -70,12 +68,12 @@
}
/**
- * ewl_check_init - initialize the members and callbacks of a check
- * @cb: the check to initialize
- * @label: the label to give the initialized check
+ * @param cb: the check to initialize
+ * @return Returns no value.
+ * @brief Initialize the members and callbacks of a check
*
- * Returns no vlalue.The internal structures and callbacks of the check
- * are initialized ot default values.
+ * The internal structures and callbacks of the check are initialized ot
+ * default values.
*/
void ewl_check_init(Ewl_Check * cb)
{
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_check.h,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ewl_check.h 25 May 2002 05:46:40 -0000 1.1
+++ ewl_check.h 1 Sep 2003 04:57:07 -0000 1.2
@@ -1,13 +1,33 @@
#ifndef _EWL_CHECK_H_
#define _EWL_CHECK_H_
-typedef struct _ewl_check Ewl_Check;
+/**
+ * @defgroup Ewl_Check The Simple Check for a Checkbutton
+ * Defines a widget with single purpose of providing a button with a checked
+ * state, without any extra decorating.
+ */
+/**
+ * A single purpose extension of Ewl_Widget to provide a checked state.
+ */
+typedef struct Ewl_Check Ewl_Check;
+
+/**
+ * @def EWL_CHECK(c)
+ * Typecasts a pointer to an Ewl_Check pointer.
+ *
+ * @{
+ */
#define EWL_CHECK(c) ((Ewl_Check *)c)
-struct _ewl_check {
- Ewl_Widget w;
- int checked;
+/**
+ * @struct Ewl_Check
+ * Inherits from Ewl_Check and extends it to provide a checked state.
+ */
+struct Ewl_Check
+{
+ Ewl_Widget w; /**< Inherit from Ewl_Widget */
+ int checked; /**< Indicates if this is checked */
};
Ewl_Widget *ewl_check_new();
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_checkbutton.h,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -3 -r1.14 -r1.15
--- ewl_checkbutton.h 29 Aug 2003 17:56:13 -0000 1.14
+++ ewl_checkbutton.h 1 Sep 2003 04:57:07 -0000 1.15
@@ -3,9 +3,11 @@
#define __EWL_CHECKBUTTON_H__
/**
- * @file ewl_checkbutton.h
+ * @defgroup Ewl_CheckButton A CheckButton with Label
* @brief Defines an Ewl_CheckButton that inherits from Ewl_Widget and
* provides an Ewl_Check that changes value on each click.
+ *
+ * @{
*/
/**
@@ -37,11 +39,26 @@
Ewl_Widget *ewl_checkbutton_new(char *l);
void ewl_checkbutton_init(Ewl_CheckButton * cb, char *label);
+/**
+ * @def ewl_checkbutton_set_checked(cb, c);
+ * Shortcut for dereferencing the checkbutton to update the checked state of
+ * the Ewl_Check.
+ */
#define ewl_checkbutton_set_checked(cb, c) \
ewl_check_set_checked(EWL_CHECK(cb->check), c)
+
+/**
+ * @def ewl_checkbutton_is_checked(cb);
+ * Shortcut for dereferencing the checkbutton to test the checked state of
+ * the Ewl_Check.
+ */
#define ewl_checkbutton_is_checked(cb) \
ewl_check_is_checked(EWL_CHECK(cb->check))
void ewl_checkbutton_set_label_position(Ewl_Widget * w,
Ewl_Position p);
+
+/**
+ * @}
+ */
#endif /* __EWL_CHECKBUTTON_H__ */
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_container.h,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -3 -r1.21 -r1.22
--- ewl_container.h 27 Aug 2003 07:21:14 -0000 1.21
+++ ewl_container.h 1 Sep 2003 04:57:07 -0000 1.22
@@ -2,9 +2,11 @@
#define __EWL_CONTAINER_H__
/**
- * @file ewl_container.h
- * Define the Ewl_Container class which inherits from Ewl_Widget and adds the
- * ability to nest Ewl_Widget's inside.
+ * @defgroup Ewl_Container The Base Class for Widgets Holding Other Widgets
+ * @brief Define the Ewl_Container class which inherits from Ewl_Widget and adds
+ * the ability to nest Ewl_Widget's inside.
+ *
+ * @{
*/
/**
@@ -48,16 +50,11 @@
*/
struct Ewl_Container
{
- Ewl_Widget widget; /**< Inherit the basics of the widget. */
-
- Ewd_List *children; /**< List of children that are contained. */
-
- Evas_Object *clip_box; /**< Clip box to bound widgets inside. */
-
- Ewl_Child_Add child_add; /**< Function called on child add */
-
- Ewl_Child_Add child_remove; /**< Function called on child remove */
-
+ Ewl_Widget widget; /**< Inherit the basics of the widget. */
+ Ewd_List *children; /**< List of children that are contained. */
+ Evas_Object *clip_box; /**< Clip box to bound widgets inside. */
+ Ewl_Child_Add child_add; /**< Function called on child add */
+ Ewl_Child_Add child_remove; /**< Function called on child remove */
Ewl_Child_Resize child_resize; /**< Function called on child resize */
};
@@ -92,5 +89,9 @@
int ewl_container_parent_of(Ewl_Widget *c, Ewl_Widget *w);
void ewl_container_prefer_largest(Ewl_Container *c,
Ewl_Orientation o);
+
+/**
+ * @}
+ */
#endif /* __EWL_CONTAINER_H__ */
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_embed.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- ewl_embed.h 27 Aug 2003 06:27:52 -0000 1.2
+++ ewl_embed.h 1 Sep 2003 04:57:07 -0000 1.3
@@ -3,9 +3,11 @@
#define __EWL_EMBED_H__
/**
- * @file ewl_embed.h
+ * @defgroup 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,5 +43,9 @@
void ewl_embed_font_path_add(char *path);
Ewl_Embed *ewl_embed_find_by_evas_window(Window win);
Ewl_Embed *ewl_embed_find_by_widget(Ewl_Widget * w);
+
+/**
+ * @}
+ */
#endif /* __EWL_EMBED_H__ */
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_entry.h,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -3 -r1.22 -r1.23
--- ewl_entry.h 28 Aug 2003 06:20:54 -0000 1.22
+++ ewl_entry.h 1 Sep 2003 04:57:07 -0000 1.23
@@ -3,8 +3,10 @@
#define __EWL_ENTRY_H__
/**
- * @file ewl_entry.h
- * Defines the Ewl_Entry class to allow for single line editable text.
+ * @defgroup Ewl_Entry A Single Line Text Entry Widget
+ * @brief Defines the Ewl_Entry class to allow for single line editable text.
+ *
+ * @{
*/
/**
@@ -39,5 +41,9 @@
void ewl_entry_set_text(Ewl_Entry * e, char *t);
char *ewl_entry_get_text(Ewl_Entry * e);
void ewl_entry_set_editable(Ewl_Entry *e, unsigned int edit);
+
+/**
+ * @}
+ */
#endif /* __EWL_ENTRY_H__ */
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_floater.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -3 -r1.4 -r1.5
--- ewl_floater.h 1 Sep 2003 03:16:02 -0000 1.4
+++ ewl_floater.h 1 Sep 2003 04:57:07 -0000 1.5
@@ -3,9 +3,11 @@
#define __EWL_FLOATER_H__
/**
- * @file ewl_floater.h
- * Defines a widget for layering above other widgets in EWL's drawing area,
- * with the ability to follow the movement of another widget.
+ * @defgroup Ewl_Floater A Floating Container
+ * @brief Defines a widget for layering above other widgets in EWL's drawing
+ * area, with the ability to follow the movement of another widget.
+ *
+ * @{
*/
/**
@@ -38,5 +40,8 @@
void ewl_floater_set_position(Ewl_Floater * parent, int x, int y);
void ewl_floater_init(Ewl_Floater * f, Ewl_Widget * parent);
+/**
+ * @}
+ */
#endif /* __EWL_FLOATER_H__ */
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_macros.h,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -3 -r1.16 -r1.17
--- ewl_macros.h 29 Aug 2003 17:56:13 -0000 1.16
+++ ewl_macros.h 1 Sep 2003 04:57:07 -0000 1.17
@@ -3,7 +3,7 @@
#define __EWL_MACROS_H__
/**
- * @file ewl_macros.h
+ * @defgroup Ewl_Macros Useful Macros Used Internally and Available Externally
* Defines a variety of utility macros.
*/
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_menu_base.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- ewl_menu_base.h 31 Aug 2003 05:47:09 -0000 1.5
+++ ewl_menu_base.h 1 Sep 2003 04:57:07 -0000 1.6
@@ -2,9 +2,11 @@
#define __EWL_MENU_BASE_H__
/**
- * @file ewl_menu_base.h
- * Defines the basic menu classes that are extended to an actual menu
+ * @defgroup Ewl_Menu_Base The Basic Menu Functionality
+ * @brief Defines the basic menu classes that are extended to an actual menu
* implementation by inheriting classes such as Ewl_Menu and Ewl_IMenu.
+ *
+ * @{
*/
/**
@@ -83,5 +85,9 @@
void ewl_menu_base_init(Ewl_Menu_Base * menu, char *image,
char *title);
+
+/**
+ * @}
+ */
#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_object.h,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -3 -r1.31 -r1.32
--- ewl_object.h 27 Aug 2003 06:27:52 -0000 1.31
+++ ewl_object.h 1 Sep 2003 04:57:07 -0000 1.32
@@ -2,7 +2,7 @@
#define __EWL_OBJECT_H__
/**
- * @file ewl_object.h
+ * @defgroup Ewl_Object Basic Object Inherited by Ewl_Widget
* @brief Defines the Ewl_Object class along with methods and macros related
* to it.
*/
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_seeker.h,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -3 -r1.14 -r1.15
--- ewl_seeker.h 31 Aug 2003 02:59:46 -0000 1.14
+++ ewl_seeker.h 1 Sep 2003 04:57:07 -0000 1.15
@@ -3,7 +3,7 @@
#define __EWL_SEEKER_H__
/**
- * @file ewl_seeker.h
+ * @defgroup Ewl_Seeker A Value Selector from a Range
* Defines an Ewl_Widget with a draggable button enclosed, used to select a
* value from a range.
*
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_separator.h,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -3 -r1.13 -r1.14
--- ewl_separator.h 27 Aug 2003 22:00:14 -0000 1.13
+++ ewl_separator.h 1 Sep 2003 04:57:07 -0000 1.14
@@ -3,7 +3,7 @@
#define __EWL_SEPARATOR_H__
/**
- * @file ewl_separator.h
+ * @defgroup Ewl_Separator A Visual Separator Between Widgets
* Defines the Ewl_Separator class used for drawing lines between widgets when
* visual separation is needed.
*/
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_spacer.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- ewl_spacer.h 31 Aug 2003 02:59:46 -0000 1.3
+++ ewl_spacer.h 1 Sep 2003 04:57:07 -0000 1.4
@@ -3,9 +3,11 @@
#define __EWL_SPACER_H__
/**
- * @file ewl_spacer.h
+ * @defgroup Ewl_Spacer A Widget to Add Space Between Other Widgets
* Defines an Ewl_Widget to be used for adding space between widgets in a
* layout.
+ *
+ * @{
*/
/**
@@ -32,5 +34,9 @@
Ewl_Widget *ewl_spacer_new();
void ewl_spacer_init(Ewl_Spacer * s);
+
+/**
+ * @}
+ */
#endif /* __EWL_SPACER_H__ */
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_text.h,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -3 -r1.23 -r1.24
--- ewl_text.h 28 Aug 2003 06:10:04 -0000 1.23
+++ ewl_text.h 1 Sep 2003 04:57:07 -0000 1.24
@@ -3,8 +3,10 @@
#define __EWL_TEXT_H
/**
- * @file ewl_text.h
+ * @defgroup Ewl_Text A Single Line Text Display
* @brief Defines the Ewl_Text class to provide text display in a single line.
+ *
+ * @{
*/
/**
@@ -68,5 +70,9 @@
int *th);
void ewl_text_set_alignment(Ewl_Text * t, Ewl_Alignment a);
int ewl_text_get_index_at(Ewl_Text * t, int x, int y);
+
+/**
+ * @}
+ */
#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_textarea.h,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -3 -r1.6 -r1.7
--- ewl_textarea.h 31 Aug 2003 05:47:09 -0000 1.6
+++ ewl_textarea.h 1 Sep 2003 04:57:07 -0000 1.7
@@ -3,8 +3,10 @@
#define __EWL_TEXTAREA_H__
/**
- * @file ewl_textarea.h
- * Defines a class for multi-line text layout and formatting.
+ * @defgroup Ewl_TextArea A Multi-Line Text Layout Display
+ * @brief Defines a class for multi-line text layout and formatting.
+ *
+ * @{
*/
/**
@@ -42,5 +44,9 @@
void ewl_textarea_set_context(Ewl_TextArea * ta,
Etox_Context * context);
Etox_Context *ewl_textarea_get_context(Ewl_TextArea * ta);
+
+/**
+ * @}
+ */
#endif /* __EWL_TEXTAREA_H__ */
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_theme.h,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -3 -r1.16 -r1.17
--- ewl_theme.h 29 Aug 2003 17:56:13 -0000 1.16
+++ ewl_theme.h 1 Sep 2003 04:57:07 -0000 1.17
@@ -3,9 +3,11 @@
#define __EWL_THEME_H__
/**
- * @file ewl_theme.h
+ * @defgroup Ewl_Theme Methods for Accessing and Modifying Theme Data
* Provides methods for accessing theme data, global theme data or per-widget
* theme data.
+ *
+ * @{
*/
int ewl_theme_init(void);
@@ -21,5 +23,9 @@
void ewl_theme_data_set_int(Ewl_Widget * w, char *k, int v);
void ewl_theme_data_set_default_str(char *k, char *v);
void ewl_theme_data_set_default_int(char *k, int v);
+
+/**
+ * @}
+ */
#endif /* __EWL_THEME_H__ */
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_tree.h,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -3 -r1.12 -r1.13
--- ewl_tree.h 31 Aug 2003 02:59:46 -0000 1.12
+++ ewl_tree.h 1 Sep 2003 04:57:07 -0000 1.13
@@ -2,9 +2,11 @@
#define _EWL_TREE_H
/**
- * @file ewl_tree.h
- * Defines a widget for laying out other widgets in a tree or list like
+ * @defgroup Ewl_Tree A Widget for List or Tree Layout
+ * @brief Defines a widget for laying out other widgets in a tree or list like
* manner.
+ *
+ * @{
*/
typedef struct Ewl_Tree Ewl_Tree;
@@ -82,5 +84,9 @@
void ewl_tree_destroy_row(Ewl_Tree *tree, Ewl_Row *row);
void ewl_tree_set_row_expand(Ewl_Row *row, Ewl_Tree_Node_Flags expanded);
Ewl_Row *ewl_tree_find_row(Ewl_Tree *tree, int row);
+
+/**
+ * @}
+ */
#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_widget.h,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -3 -r1.31 -r1.32
--- ewl_widget.h 27 Aug 2003 06:27:52 -0000 1.31
+++ ewl_widget.h 1 Sep 2003 04:57:07 -0000 1.32
@@ -2,8 +2,10 @@
#define __EWL_WIDGET_H__
/**
- * @file ewl_widget.h
- * Defines the Ewl_Widget class and it's accessor/modifier functions.
+ * @defgroup Ewl_Widget The Parent Widget Class Common to All Widgets
+ * @brief Defines the Ewl_Widget class and it's accessor/modifier functions.
+ *
+ * @{
*/
/**
@@ -139,12 +141,44 @@
*/
void ewl_widget_rebuild_appearance(Ewl_Widget *w);
+/**
+ * @def RECURSIVE(w)
+ * Used to test if a widget is recursive, aka. an Ewl_Container
+ */
#define RECURSIVE(w) (EWL_WIDGET(w)->flags & EWL_FLAGS_RECURSIVE)
+/**
+ * @def REALIZED(w)
+ * Used to test if a widget has been realized.
+ */
#define REALIZED(w) (EWL_WIDGET(w)->flags & EWL_FLAGS_REALIZED)
+
+/**
+ * @def VISIBLE(w)
+ * Used to test if a widget is visible.
+ */
#define VISIBLE(w) (EWL_WIDGET(w)->flags & EWL_FLAGS_SHOWN)
+
+/**
+ * @def OBSCURED(w)
+ * Used to determine if a widget is marked as obscured.
+ */
#define OBSCURED(w) (EWL_WIDGET(w)->flags & EWL_FLAGS_OBSCURED)
+
+/**
+ * @def HIDDEN(w)
+ * Used to determine if a widget is hidden.
+ */
#define HIDDEN(w) (!(EWL_WIDGET(w)->flags & EWL_FLAGS_SHOWN))
+
+/**
+ * @def HIDDEN(w)
+ * Used to retrieve the layer of a widget.
+ */
#define LAYER(w) EWL_WIDGET(w)->layer
+
+/**
+ * @}
+ */
#endif /* __EWL_WIDGET_H__ */
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_window.h,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -3 -r1.21 -r1.22
--- ewl_window.h 27 Aug 2003 06:27:52 -0000 1.21
+++ ewl_window.h 1 Sep 2003 04:57:07 -0000 1.22
@@ -3,9 +3,11 @@
#define __EWL_WINDOW_H__
/**
- * @file ewl_window.h
- * Defines the Ewl_Window class which extends the Ewl_Embed class by creating
- * it's own window and evas.
+ * @defgroup Ewl_Window A Container for Displaying in a New Window
+ * @brief Defines the Ewl_Window class which extends the Ewl_Embed class by
+ * creating it's own window and evas.
+ *
+ * @{
*/
/**
@@ -48,5 +50,9 @@
void ewl_window_set_borderless(Ewl_Window * win);
void ewl_window_move(Ewl_Window * win, int x, int y);
void ewl_window_get_position(Ewl_Window * win, int *x, int *y);
+
+/**
+ * @}
+ */
#endif /* __EWL_WINDOW_H__ */
-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
