Enlightenment CVS committal
Author : ncn
Project : e17
Module : libs/evas
Dir : e17/libs/evas/src/lib/canvas
Modified Files:
evas_callbacks.c evas_data.c evas_layer.c evas_name.c
evas_object_rectangle.c
Log Message:
Just some more docs. A few todos inserted, to be fixed soon.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/evas/src/lib/canvas/evas_callbacks.c,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -3 -r1.16 -r1.17
--- evas_callbacks.c 16 Feb 2004 19:22:48 -0000 1.16
+++ evas_callbacks.c 23 Aug 2004 23:04:33 -0000 1.17
@@ -193,6 +193,17 @@
}
/**
+ * @defgroup Evas_Object_Callback_Group Object Callback Functions
+ *
+ * Functions that add and remove callbacks to evas objects.
+ */
+
+/**
+ * @todo Move this next code example and most of the documentation for
+ * this next function into the group documentation.
+ */
+
+/**
* Add a callback function to an object
* @param obj Object to attach a callback to
* @param type The type of event that will trigger the callback
@@ -347,6 +358,7 @@
* exit(-1);
* }
* @endcode
+ * @ingroup Evas_Object_Callback_Group
*/
void
evas_object_event_callback_add(Evas_Object *obj, Evas_Callback_Type type, void
(*func) (void *data, Evas *e, Evas_Object *obj, void *event_info), const void *data)
@@ -453,6 +465,7 @@
*
* my_data = evas_object_event_callback_del(object, EVAS_CALLBACK_MOUSE_UP,
up_callback);
* @endcode
+ * @ingroup Evas_Object_Callback_Group
*/
void *
evas_object_event_callback_del(Evas_Object *obj, Evas_Callback_Type type, void
(*func) (void *data, Evas *e, Evas_Object *obj, void *event_info))
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/evas/src/lib/canvas/evas_data.c,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -3 -r1.4 -r1.5
--- evas_data.c 20 Feb 2004 07:06:39 -0000 1.4
+++ evas_data.c 23 Aug 2004 23:04:33 -0000 1.5
@@ -3,6 +3,13 @@
#include "Evas.h"
/**
+ * @defgroup Evas_Object_Data_Group Object Data Functions
+ *
+ * Functions that retrieve and set data associated attached to an evas
+ * object.
+ */
+
+/**
* Set an attached data pointer to an object with a given string key.
* @param obj The object to attach the data pointer to
* @param key The string key for the data to access it
@@ -32,6 +39,7 @@
* evas_object_data_set(obj, "name_of_data", my_data);
* printf("The data that was attached was %p\n", evas_object_data_get(obj,
"name_of_data"));
* @endcode
+ * @ingroup Evas_Object_Data_Group
*/
void
evas_object_data_set(Evas_Object *obj, const char *key, const void *data)
@@ -75,6 +83,8 @@
* my_data = evas_object_data_get(obj, "name_of_my_data");
* if (my_data) printf("Data stored was %p\n", my_data);
* else printf("No data was stored on the object\n");
+ * @endcode
+ * @ingroup Evas_Object_Data_Group
*/
void *
evas_object_data_get(Evas_Object *obj, const char *key)
@@ -119,6 +129,7 @@
*
* my_data = evas_object_data_del(obj, "name_of_my_data");
* @endcode
+ * @ingroup Evas_Object_Data_Group
*/
void *
evas_object_data_del(Evas_Object *obj, const char *key)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/evas/src/lib/canvas/evas_layer.c,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -3 -r1.7 -r1.8
--- evas_layer.c 9 Oct 2003 03:05:17 -0000 1.7
+++ evas_layer.c 23 Aug 2004 23:04:33 -0000 1.8
@@ -119,10 +119,18 @@
/* public functions */
/**
- * To be documented.
+ * @defgroup Evas_Object_Layer_Group Object Layer Functions
*
- * FIXME: To be fixed.
+ * Functions that retrieve and set the layer that an evas object is on.
*
+ * @todo Document which way layers go.
+ */
+
+/**
+ * Sets the layer of the evas that the given object will be part of.
+ * @param obj The given evas object.
+ * @param l The number of the layer to place the object on.
+ * @ingroup Evas_Object_Layer_Group
*/
void
evas_object_layer_set(Evas_Object *obj, int l)
@@ -167,10 +175,10 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
- *
+ * Retrieves the layer of the evas that the given object is part of.
+ * @param obj The given evas object.
+ * @return Number of the layer.
+ * @ingroup Evas_Object_Layer_Group
*/
int
evas_object_layer_get(Evas_Object *obj)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/evas/src/lib/canvas/evas_name.c,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- evas_name.c 5 Mar 2003 02:30:17 -0000 1.3
+++ evas_name.c 23 Aug 2004 23:04:34 -0000 1.4
@@ -3,10 +3,16 @@
#include "Evas.h"
/**
- * To be documented.
+ * @defgroup Evas_Object_Name_Group Object Name Function
*
- * FIXME: To be fixed.
- *
+ * Functions that retrieve and set the name of an evas object.
+ */
+
+/**
+ * Sets the name of the given evas object to the given name.
+ * @param obj The given object.
+ * @param name The given name.
+ * @ingroup Evas_Object_Name_Group
*/
void
evas_object_name_set(Evas_Object *obj, const char *name)
@@ -28,10 +34,11 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
- *
+ * Retrieves the name of the given evas object.
+ * @param obj The given object.
+ * @return The name of the object. @c NULL if no name has been given
+ * to the object.
+ * @ingroup Evas_Object_Name_Group
*/
const char *
evas_object_name_get(Evas_Object *obj)
@@ -43,10 +50,12 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
- *
+ * Retrieves the object on the given evas with the given name.
+ * @param e The given evas.
+ * @param name The given name.
+ * @return If successful, the evas object with the given name. Otherwise,
+ * @c NULL.
+ * @ingroup Evas_Object_Name_Group
*/
Evas_Object *
evas_object_name_find(Evas *e, const char *name)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/evas/src/lib/canvas/evas_object_rectangle.c,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- evas_object_rectangle.c 16 Feb 2004 19:22:48 -0000 1.3
+++ evas_object_rectangle.c 23 Aug 2004 23:04:34 -0000 1.4
@@ -56,10 +56,10 @@
/* it has no other api calls as all properties are standard */
/**
- * To be documented.
- *
- * FIXME: To be fixed.
- *
+ * Adds a rectangle to the given evas.
+ * @param e The given evas.
+ * @return The new rectangle object.
+ * @todo Find a documentation group to put this under.
*/
Evas_Object *
evas_object_rectangle_add(Evas *e)
-------------------------------------------------------
SF.Net email is sponsored by Shop4tech.com-Lowest price on Blank Media
100pk Sonic DVD-R 4x for only $29 -100pk Sonic DVD+R for only $33
Save 50% off Retail on Ink & Toner - Free Shipping and Free Gift.
http://www.shop4tech.com/z/Inkjet_Cartridges/9_108_r285
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs