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_border.c ewl_border.h
Log Message:
- move some of the attach functions to be static
- doxygen fixes
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_attach.c,v
retrieving revision 1.26
retrieving revision 1.27
diff -u -3 -r1.26 -r1.27
--- ewl_attach.c 12 Jan 2006 18:21:18 -0000 1.26
+++ ewl_attach.c 15 Feb 2006 16:52:17 -0000 1.27
@@ -20,6 +20,19 @@
Ewl_Widget *to;
};
+static Ewl_Attach_List *ewl_attach_list_new(void);
+static void ewl_attach_list_free(Ewl_Attach_List *list);
+
+static void ewl_attach_list_add(Ewl_Attach_List *list, Ewl_Widget *parent,
+ Ewl_Attach *attach);
+static void *ewl_attach_list_get(Ewl_Attach_List *list, Ewl_Attach_Type type);
+
+static Ewl_Attach *ewl_attach_new(Ewl_Attach_Type t,
+ Ewl_Attach_Data_Type dt, void *data);
+static int ewl_attach_init(Ewl_Attach *attach, Ewl_Attach_Type t,
+ Ewl_Attach_Data_Type dt, void *data);
+static void ewl_attach_free(Ewl_Attach *attach);
+
static void ewl_attach_parent_setup(Ewl_Widget *w);
static void ewl_attach_cb_parent_destroy(Ewl_Widget *w, void *ev, void *data);
static void ewl_attach_attach_type_setup(Ewl_Widget *w, Ewl_Attach *attach);
@@ -41,6 +54,7 @@
* @param t: The type of the attachment
* @param data: The text to set as the attachment
* @return Returns no value
+ * @brief Attaches the text @p data to the widget @p w
*/
void
ewl_attach_text_set(Ewl_Widget *w, Ewl_Attach_Type t, const char *data)
@@ -72,6 +86,7 @@
* @param t: The type of data being attached
* @param data: The wiget to attach
* @return Returns no value
+ * @brief Attaches a widget @p data to the widget @p w
*/
void
ewl_attach_widget_set(Ewl_Widget *w, Ewl_Attach_Type t, Ewl_Widget *data)
@@ -104,6 +119,8 @@
* @param t: The type of attachment
* @param data: The data to attach
* @return Returns no value
+ * @brief Attaches the data @p data to the widget @p w with the attache type
+ * of @p t
*/
void
ewl_attach_other_set(Ewl_Widget *w, Ewl_Attach_Type t, void *data)
@@ -133,6 +150,7 @@
* @param w: The widget to get the attachment from
* @param t: The type of attachment to get
* @return Returns the data for the given attachment type
+ * @brief Get the attachment of type @p t from the widget @p w
*/
void *
ewl_attach_get(Ewl_Widget *w, Ewl_Attach_Type t)
@@ -156,7 +174,7 @@
DRETURN_PTR(NULL, DLEVEL_STABLE);
}
-Ewl_Attach_List *
+static Ewl_Attach_List *
ewl_attach_list_new(void)
{
Ewl_Attach_List *list;
@@ -168,7 +186,7 @@
DRETURN_PTR(list, DLEVEL_STABLE);
}
-void
+static void
ewl_attach_list_free(Ewl_Attach_List *list)
{
DENTER_FUNCTION(DLEVEL_STABLE);
@@ -193,7 +211,7 @@
DLEAVE_FUNCTION(DLEVEL_STABLE);
}
-void
+static void
ewl_attach_list_add(Ewl_Attach_List *list, Ewl_Widget *parent, Ewl_Attach
*attach)
{
DENTER_FUNCTION(DLEVEL_STABLE);
@@ -280,6 +298,12 @@
DLEAVE_FUNCTION(DLEVEL_STABLE);
}
+/**
+ * @param list: The Ewl_Attach_List to delete
+ * @param type: The Ewl_Attach_Type to delete
+ * @return Returns no value
+ * @brief Deletes the given type @p type from the list @p list
+ */
void
ewl_attach_list_del(Ewl_Attach_List *list, Ewl_Attach_Type type)
{
@@ -333,7 +357,7 @@
DLEAVE_FUNCTION(DLEVEL_STABLE);
}
-void *
+static void *
ewl_attach_list_get(Ewl_Attach_List *list, Ewl_Attach_Type type)
{
DENTER_FUNCTION(DLEVEL_STABLE);
@@ -372,7 +396,7 @@
DRETURN_PTR(NULL, DLEVEL_STABLE);
}
-Ewl_Attach *
+static Ewl_Attach *
ewl_attach_new(Ewl_Attach_Type t, Ewl_Attach_Data_Type dt, void *data)
{
Ewl_Attach *attach;
@@ -393,7 +417,7 @@
DRETURN_PTR(attach, DLEVEL_STABLE);
}
-int
+static int
ewl_attach_init(Ewl_Attach *attach, Ewl_Attach_Type t,
Ewl_Attach_Data_Type dt, void *data)
{
@@ -411,7 +435,7 @@
DRETURN_INT(TRUE, DLEVEL_STABLE);
}
-void
+static void
ewl_attach_free(Ewl_Attach *attach)
{
DENTER_FUNCTION(DLEVEL_STABLE);
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_attach.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- ewl_attach.h 3 Feb 2006 18:14:30 -0000 1.5
+++ ewl_attach.h 15 Feb 2006 16:52:18 -0000 1.6
@@ -2,25 +2,36 @@
#define EWL_ATTACH_H
/**
- * @file ewl_attach.h
- * @defgroup Ewl_Attach Attachments: The attachment mechanisms
- * Defines methods for attaching data to widgets
+ * @defgroup Ewl_Attach Ewl_Attach: A mechanism to attach data to widgets.
+ * @brief Defines methods for attaching data to widgets
*
* @{
*/
#define EWL_ATTACH_TOOLTIP_TYPE "tooltip"
+/**
+ * @def EWL_ATTACH(attach)
+ * Typecast a pointer to an Ewl_Attach pointer
+ */
#define EWL_ATTACH(attach) ((Ewl_Attach *) attach)
+/**
+ * Ewl_Attach provides a way to attach data to widgets
+ */
typedef struct Ewl_Attach Ewl_Attach;
+
+/**
+ * @struct Ewl_Attach
+ * Contains the attachment information
+ */
struct Ewl_Attach
{
- Ewl_Attach_Type type;
- Ewl_Attach_Data_Type data_type;
+ Ewl_Attach_Type type; /**< The type of the attachment */
+ Ewl_Attach_Data_Type data_type; /**< The data type of the attachment */
- void *data;
- void *priv_data;
+ void *data; /**< The attachment data */
+ void *priv_data; /**< Any private data in the attachment
*/
};
/**
@@ -39,7 +50,7 @@
/**
- * @def ewl_attach_pointer_set(w, data)
+ * @def ewl_attach_mouse_pointer_set(w, data)
* Convience method to set a pointer widget attachment
*/
#define ewl_attach_mouse_cursor_set(w, data) \
@@ -91,22 +102,9 @@
void ewl_attach_text_set(Ewl_Widget *w, Ewl_Attach_Type t, const char *data);
void ewl_attach_widget_set(Ewl_Widget *w, Ewl_Attach_Type t, Ewl_Widget *data);
void ewl_attach_other_set(Ewl_Widget *w, Ewl_Attach_Type t, void *data);
-
void *ewl_attach_get(Ewl_Widget *w, Ewl_Attach_Type t);
-/*
- * internal stuff
- */
-Ewl_Attach_List *ewl_attach_list_new(void);
-void ewl_attach_list_free(Ewl_Attach_List *list);
-
-void ewl_attach_list_add(Ewl_Attach_List *list, Ewl_Widget *parent, Ewl_Attach
*attach);
void ewl_attach_list_del(Ewl_Attach_List *list, Ewl_Attach_Type type);
-void *ewl_attach_list_get(Ewl_Attach_List *list, Ewl_Attach_Type type);
-
-Ewl_Attach *ewl_attach_new(Ewl_Attach_Type t, Ewl_Attach_Data_Type dt, void
*data);
-int ewl_attach_init(Ewl_Attach *attach, Ewl_Attach_Type t,
Ewl_Attach_Data_Type dt, void *data);
-void ewl_attach_free(Ewl_Attach *attach);
/**
* @}
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_border.c,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -3 -r1.11 -r1.12
--- ewl_border.c 12 Jan 2006 18:21:18 -0000 1.11
+++ ewl_border.c 15 Feb 2006 16:52:18 -0000 1.12
@@ -104,7 +104,7 @@
* @param b: The Ewl_Border to set the label position on
* @param pos: The Ewl_Position to set on for the label.
* @return Returns no value.
- * @brief Sets the position of the lable in the border container
+ * @brief Sets the position of the label in the border container
*/
void
ewl_border_label_position_set(Ewl_Border *b, Ewl_Position pos)
@@ -155,6 +155,7 @@
/**
* @param b: The Ewl_Border to get the label position from
* @return Returns the Ewl_Position setting of the label on this border
+ * @brief Gets the label position of the border
*/
Ewl_Position
ewl_border_label_position_get(Ewl_Border *b)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_border.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- ewl_border.h 12 Jan 2006 18:21:18 -0000 1.5
+++ ewl_border.h 15 Feb 2006 16:52:18 -0000 1.6
@@ -1,10 +1,8 @@
-#ifndef __EWL_BORDER_H__
-#define __EWL_BORDER_H__
+#ifndef EWL_BORDER_H
+#define EWL_BORDER_H
/**
- * @file ewl_border.h
- *
- * @defgroup Ewl_Border Border: A container with a border and label
+ * @defgroup Ewl_Border Ewl_Border: A container with a border and label
* @brief Defines the Ewl_Border class used for adding a border decoration
* around a group of widgets.
*
@@ -19,8 +17,7 @@
#define EWL_BORDER_TYPE "border"
/**
- * Provides an Ewl_Widget to simply act as a separator between other
- * Ewl_Widget's.
+ * Ewl_Border provides a container that has a labeled border.
*/
typedef struct Ewl_Border Ewl_Border;
@@ -60,5 +57,5 @@
* @}
*/
-#endif /* __EWL_BORDER_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
