Enlightenment CVS committal
Author : dj2
Project : e17
Module : libs/ewl
Dir : e17/libs/ewl/src/lib
Modified Files:
ewl_container.c ewl_container.h ewl_datepicker.c
ewl_datepicker.h ewl_debug.h ewl_dialog.c ewl_dialog.h
Log Message:
- documentation
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_container.c,v
retrieving revision 1.34
retrieving revision 1.35
diff -u -3 -r1.34 -r1.35
--- ewl_container.c 9 Feb 2006 18:07:53 -0000 1.34
+++ ewl_container.c 15 Feb 2006 21:25:01 -0000 1.35
@@ -492,6 +492,7 @@
* @param parent: The container to get the child from
* @param index: The child index to return
* @return Returns the widget at the given index, or NULL if not found
+ * @brief Retrieve the child at the given index in the container.
*/
Ewl_Widget *
ewl_container_child_get(Ewl_Container *parent, int index)
@@ -512,6 +513,8 @@
* @param index: The child index to return
* @return Returns the widget at the given index including internal widgets,
* or NULL if not found
+ * @brief Retrieves the child at the given index in the container taking
+ * internal widgets into account.
*/
Ewl_Widget *
ewl_container_child_internal_get(Ewl_Container *parent, int index)
@@ -558,6 +561,7 @@
* @param parent: The container to search
* @param w: The child to search for
* @return Returns the index of the child in the parent
+ * @brief Retrieves the index of the given child in the container
*/
unsigned int
ewl_container_child_index_get(Ewl_Container *parent, Ewl_Widget *w)
@@ -580,6 +584,8 @@
* @param w: The child to search for
* @return Returns the index of the child in the parent including internal
* widgets
+ * @brief Retrieves the index of the given child in the container taking
+ * internal widgets into account
*/
unsigned int
ewl_container_child_index_internal_get(Ewl_Container *parent, Ewl_Widget *w)
@@ -983,6 +989,8 @@
/**
* @param c: the container to use the child size sum in a specified direction
* @param o: the orientation direction of the sum to use
+ * @return Returns no value
+ * @brief Set the sum orientation of the container
*/
void
ewl_container_sum_prefer(Ewl_Container *c, Ewl_Orientation o)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_container.h,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -3 -r1.16 -r1.17
--- ewl_container.h 9 Feb 2006 18:07:55 -0000 1.16
+++ ewl_container.h 15 Feb 2006 21:25:01 -0000 1.17
@@ -1,9 +1,8 @@
-#ifndef __EWL_CONTAINER_H__
-#define __EWL_CONTAINER_H__
+#ifndef EWL_CONTAINER_H
+#define EWL_CONTAINER_H
/**
- * @file ewl_container.h
- * @defgroup Ewl_Container Container: Widgets Holding Other Widgets
+ * @defgroup Ewl_Container Ewl_Container: 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.
*
@@ -170,4 +169,4 @@
* @}
*/
-#endif /* __EWL_CONTAINER_H__ */
+#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_datepicker.c,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -3 -r1.8 -r1.9
--- ewl_datepicker.c 12 Jan 2006 18:21:18 -0000 1.8
+++ ewl_datepicker.c 15 Feb 2006 21:25:01 -0000 1.9
@@ -34,6 +34,7 @@
/**
* @param db: The Ewl_Datepicker to initialize
* @return Returns TRUE on success or FALSE on failure
+ * @brief Initialize the date picker to default values.
*/
int
ewl_datepicker_init(Ewl_Datepicker *dp)
@@ -80,7 +81,7 @@
}
void
-ewl_datepicker_destroy_cb(Ewl_Widget *w, void *ev_data __UNUSED__,
+ewl_datepicker_destroy_cb(Ewl_Widget *w, void *ev __UNUSED__,
void *user_data __UNUSED__)
{
Ewl_Datepicker *dp;
@@ -97,7 +98,7 @@
}
void
-ewl_datepicker_configure_cb(Ewl_Widget *w, void *ev_data __UNUSED__,
+ewl_datepicker_configure_cb(Ewl_Widget *w, void *ev __UNUSED__,
void *user_data __UNUSED__)
{
DENTER_FUNCTION(DLEVEL_STABLE);
@@ -110,7 +111,7 @@
}
void
-ewl_datepicker_value_changed_cb(Ewl_Widget *w __UNUSED__, void *ev_data
__UNUSED__,
+ewl_datepicker_value_changed_cb(Ewl_Widget *w __UNUSED__, void *ev __UNUSED__,
void *user_data)
{
char *date;
@@ -130,7 +131,7 @@
}
void
-ewl_datepicker_realize_cb(Ewl_Widget *w, void *ev_data __UNUSED__,
+ewl_datepicker_realize_cb(Ewl_Widget *w, void *ev __UNUSED__,
void *user_data __UNUSED__)
{
DENTER_FUNCTION(DLEVEL_STABLE);
@@ -166,7 +167,7 @@
}
static void
-ewl_datepicker_dropdown_cb(Ewl_Widget *w, void *ev_data __UNUSED__,
+ewl_datepicker_dropdown_cb(Ewl_Widget *w, void *ev __UNUSED__,
void *user_data __UNUSED__)
{
Ewl_Datepicker *dp;
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_datepicker.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -3 -r1.4 -r1.5
--- ewl_datepicker.h 12 Jan 2006 18:21:18 -0000 1.4
+++ ewl_datepicker.h 15 Feb 2006 21:25:01 -0000 1.5
@@ -1,11 +1,11 @@
-#ifndef __EWL_DATEPICKER_H__
-#define __EWL_DATEPICKER_H__
+#ifndef EWL_DATEPICKER_H
+#define EWL_DATEPICKER_H
/**
- * @file ewl_datepicker.h
- * @defgroup Ewl_Datepicker datepicker: The EWL Datepicker widget
+ * @defgroup Ewl_Datepicker Ewl_Datepicker: The EWL Datepicker widget
* @brief Defines the Ewl_Datepicker class,
*
+ * @{
*/
/**
@@ -15,6 +15,9 @@
#define EWL_DATEPICKER_TYPE "datepicker"
+/**
+ * The Ewl_Datepicker
+ */
typedef struct Ewl_Datepicker Ewl_Datepicker;
/**
@@ -26,14 +29,13 @@
/**
* @struct Ewl_Datepicker
* Inherits from an Ewl_Text
- *
*/
struct Ewl_Datepicker
{
- Ewl_Text text; /**< Inherit from Ewl_Text */
+ Ewl_Text text; /**< Inherit from Ewl_Text */
- Ewl_Widget* calendar;
- Ewl_Widget* calendar_window;
+ Ewl_Widget *calendar; /**< The calendar */
+ Ewl_Widget *calendar_window; /**< The window */
};
@@ -43,13 +45,13 @@
/*
* Internally used callbacks, override at your risk
*/
-void ewl_datepicker_destroy_cb(Ewl_Widget *w, void *ev_data,
- void *user_data);
-void ewl_datepicker_configure_cb(Ewl_Widget *w, void *ev_data,
- void *user_data);
-void ewl_datepicker_value_changed_cb(Ewl_Widget *w, void *ev_data,
- void *user_data);
-void ewl_datepicker_realize_cb(Ewl_Widget *w, void *ev_data,
- void *user_data);
+void ewl_datepicker_destroy_cb(Ewl_Widget *w, void *ev, void *user_data);
+void ewl_datepicker_configure_cb(Ewl_Widget *w, void *ev, void *user_data);
+void ewl_datepicker_value_changed_cb(Ewl_Widget *w, void *ev, void *user_data);
+void ewl_datepicker_realize_cb(Ewl_Widget *w, void *ev, void *user_data);
+
+/**
+ * @}
+ */
#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_debug.h,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -3 -r1.13 -r1.14
--- ewl_debug.h 10 Jan 2006 17:22:54 -0000 1.13
+++ ewl_debug.h 15 Feb 2006 21:25:01 -0000 1.14
@@ -1,5 +1,5 @@
-#ifndef __EWL_DEBUG_H__
-#define __EWL_DEBUG_H__
+#ifndef EWL_DEBUG_H
+#define EWL_DEBUG_H
#include "ewl_misc.h"
#include <stdio.h>
@@ -211,5 +211,5 @@
fprintf(stderr, fmt); \
}
-#endif /* __EWL_DEBUG_H__ */
+#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_dialog.c,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -3 -r1.11 -r1.12
--- ewl_dialog.c 12 Jan 2006 18:21:18 -0000 1.11
+++ ewl_dialog.c 15 Feb 2006 21:25:01 -0000 1.12
@@ -243,6 +243,13 @@
DLEAVE_FUNCTION(DLEVEL_STABLE);
}
+/**
+ * @param d: The Ewl_Dialog to work with
+ * @param pos: The area of the dialog to set active
+ * @return Returns no value
+ * @brief Sets the section of the dialog that will have widgets packed into
+ * it
+ */
void
ewl_dialog_active_area_set(Ewl_Dialog *d, Ewl_Position pos)
{
@@ -262,6 +269,11 @@
DLEAVE_FUNCTION(DLEVEL_STABLE);
}
+/**
+ * @param d: The Ewl_Dialog to get the active area from
+ * @return Returns the active portion of the dialog
+ * @brief Retrieve the location of the dialog widgets will be packed into
+ */
Ewl_Position
ewl_dialog_active_area_get(Ewl_Dialog *d)
{
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_dialog.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -3 -r1.8 -r1.9
--- ewl_dialog.h 15 Feb 2006 15:32:24 -0000 1.8
+++ ewl_dialog.h 15 Feb 2006 21:25:01 -0000 1.9
@@ -1,12 +1,8 @@
-#ifndef __EWL_DIALOG_H__
-#define __EWL_DIALOG_H__
+#ifndef EWL_DIALOG_H
+#define EWL_DIALOG_H
/**
- * @file ewl_dialog.h
- * @defgroup Ewl_Dialog Dialog: A Window to prompt the user for
- * Displaying Messages, asking
- * questions or warnings.
- *
+ * @defgroup Ewl_Dialog Ewl_Dialog: A dialog window
* @brief Defines the Ewl_Dialog class which extends the Ewl_Window class.
*
* @{
@@ -20,7 +16,7 @@
#define EWL_DIALOG_TYPE "dialog"
/**
- * The dialog structure is a window with two area: a box (vbox) to hold
+ * The dialog structure is a window with two areas: a box (vbox) to hold
* messages and another box (action_area) to put buttons
* (usually). These boxes can be separated by a line.
*/
@@ -69,4 +65,4 @@
* @}
*/
-#endif /* __EWL_DIALOG_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
