Enlightenment CVS committal
Author : dj2
Project : e17
Module : libs/ewl
Dir : e17/libs/ewl/src/lib
Modified Files:
ewl_callback.h ewl_grid.c ewl_grid.h ewl_list.c ewl_list.h
Log Message:
- doxygen fixes
===================================================================
RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_callback.h,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -3 -r1.12 -r1.13
--- ewl_callback.h 13 Jul 2006 00:20:29 -0000 1.12
+++ ewl_callback.h 16 Jul 2006 23:17:38 -0000 1.13
@@ -51,10 +51,13 @@
*/
#define EWL_CALLBACK_CUSTOM(cb) ((Ewl_Callback_Custom *)cb)
+/**
+ * The Ewl_Callback_Custom structure
+ */
struct Ewl_Callback_Custom
{
- Ewl_Callback cb;
- unsigned int event_id;
+ Ewl_Callback cb; /**< Inherit from Ewl_Callback */
+ unsigned int event_id; /**< Add an event id */
};
/**
===================================================================
RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_grid.c,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -3 -r1.22 -r1.23
--- ewl_grid.c 12 Jul 2006 03:44:19 -0000 1.22
+++ ewl_grid.c 16 Jul 2006 23:17:38 -0000 1.23
@@ -482,7 +482,7 @@
/**
* @param g: the grid
* @param col: the column
- * @param width: the new relative width
+ * @param relw: the new relative width
* @return Returns no value.
* @brief Set the relative width of a column
*/
@@ -679,7 +679,7 @@
/**
* @param g: the grid
* @param row: the row
- * @param height: the new relative height
+ * @param relh: the new relative height
* @return Returns no value.
* @brief Set the relative height of a row
*/
===================================================================
RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_grid.h,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -3 -r1.18 -r1.19
--- ewl_grid.h 12 Jul 2006 03:44:19 -0000 1.18
+++ ewl_grid.h 16 Jul 2006 23:17:38 -0000 1.19
@@ -34,7 +34,7 @@
union {
int size; /**< The size set by
the user */
float rel_size; /**< The relative size
*/
- } user;
+ } user; /**< The user set
values for the grid */
Ewl_Grid_Resize_Type resize_type; /**< Are there values
set by the user */
};
===================================================================
RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_list.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ewl_list.c 14 Jul 2006 02:53:34 -0000 1.1
+++ ewl_list.c 16 Jul 2006 23:17:38 -0000 1.2
@@ -3,6 +3,10 @@
#include "ewl_macros.h"
#include "ewl_private.h"
+/**
+ * @return Returns a new Ewl_Widget on success or NULL on failure
+ * @brief Creates and initializes a new Ewl_List widget
+ */
Ewl_Widget *
ewl_list_new(void)
{
@@ -23,6 +27,11 @@
DRETURN_PTR(list, DLEVEL_STABLE);
}
+/**
+ * @param list: The list to initialize
+ * @return Returns TRUE on success or FALSE on failure
+ * @brief Initialises an Ewl_List widget to default values
+ */
int
ewl_list_init(Ewl_List *list)
{
@@ -43,6 +52,12 @@
DRETURN_INT(TRUE, DLEVEL_STABLE);
}
+/**
+ * @param list: The Ewl_List to set the model into
+ * @param model: The model to set into the list
+ * @return Returns no value
+ * @brief Sets the model to be used for the list
+ */
void
ewl_list_model_set(Ewl_List *list, Ewl_Model *model)
{
@@ -57,6 +72,11 @@
DLEAVE_FUNCTION(DLEVEL_STABLE);
}
+/**
+ * @param list: The list to retrieve the model from
+ * @return Returns the Ewl_Model associated with the list or NULL if none set
+ * @brief Retrieves the Ewl_Model associated with the list or NULL if none set
+ */
Ewl_Model *
ewl_list_model_get(Ewl_List *list)
{
@@ -67,6 +87,12 @@
DRETURN_PTR(list->model, DLEVEL_STABLE);
}
+/**
+ * @param list: The list to set the view on
+ * @param view: The view to set into the list
+ * @return Returns no value
+ * @brief Sets the view @a view into the list @a list
+ */
void
ewl_list_view_set(Ewl_List *list, Ewl_View *view)
{
@@ -80,6 +106,11 @@
DLEAVE_FUNCTION(DLEVEL_STABLE);
}
+/**
+ * @param list: The list to get the view from
+ * @return Returns the Ewl_View set on the list or NULL if none set
+ * @brief Retrieves the Ewl_View set on the list or NULL if none set
+ */
Ewl_View *
ewl_list_view_get(Ewl_List *list)
{
@@ -90,6 +121,12 @@
DRETURN_PTR(list->view, DLEVEL_STABLE);
}
+/**
+ * @param list: The list to set the data into
+ * @param data: The data to set into the list
+ * @return Returns no value
+ * @brief Sets the given data into the list
+ */
void
ewl_list_data_set(Ewl_List *list, void *data)
{
@@ -103,6 +140,11 @@
DLEAVE_FUNCTION(DLEVEL_STABLE);
}
+/**
+ * @param list: The list to get the data from
+ * @return Returns the data set into the list or NULL if none set
+ * @brief Retrieves the data set into the list or NULL if none set
+ */
void *
ewl_list_data_get(Ewl_List *list)
{
@@ -113,6 +155,12 @@
DRETURN_PTR(list->data, DLEVEL_STABLE);
}
+/**
+ * @param list: The list to set the dirty flag of
+ * @param dirty: The dirty flag to set
+ * @return Returns no value
+ * @brief Sets the dirty status of the list @a list to @a dirty
+ */
void
ewl_list_dirty_set(Ewl_List *list, unsigned int dirty)
{
@@ -126,6 +174,11 @@
DLEAVE_FUNCTION(DLEVEL_STABLE);
}
+/**
+ * @param list: The list to retrieve the dirty flag from
+ * @return Returns the dirty flag of the list
+ * @brief Retrieves the dirty flag from the list
+ */
unsigned int
ewl_list_dirty_get(Ewl_List *list)
{
@@ -136,6 +189,14 @@
DRETURN_INT(list->dirty, DLEVEL_STABLE);
}
+/**
+ * @internal
+ * @param w: The list to be configured
+ * @param ev: UNUSED
+ * @param data: UNUSED
+ * @return Returns no value
+ * @brief Configures the given list
+ */
void
ewl_list_cb_configure(Ewl_Widget *w, void *ev __UNUSED__,
void *data __UNUSED__)
===================================================================
RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_list.h,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ewl_list.h 14 Jul 2006 02:53:34 -0000 1.1
+++ ewl_list.h 16 Jul 2006 23:17:38 -0000 1.2
@@ -30,13 +30,13 @@
*/
struct Ewl_List
{
- Ewl_Box box;
+ Ewl_Box box; /**< The box parent */
- Ewl_Model *model;
- Ewl_View *view;
- void *data;
+ Ewl_Model *model; /**< The model for the list */
+ Ewl_View *view; /**< The view for the list */
+ void *data; /**< The data for the list */
- unsigned char dirty:1;
+ unsigned char dirty:1; /**< Has the model changed? */
};
Ewl_Widget *ewl_list_new(void);
-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
