Enlightenment CVS committal

Author  : ncn
Project : e17
Module  : libs/evas

Dir     : e17/libs/evas/src/lib/canvas


Modified Files:
        evas_clip.c evas_events.c evas_object_gradient.c 
        evas_object_line.c evas_object_main.c evas_object_polygon.c 


Log Message:
More documentation, simplification and grouping.  Some of these changes are themselves 
going to require polishing, but the docs are now a little bit more organised.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/evas/src/lib/canvas/evas_clip.c,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -3 -r1.7 -r1.8
--- evas_clip.c 16 Feb 2004 19:22:48 -0000      1.7
+++ evas_clip.c 16 Aug 2004 05:13:25 -0000      1.8
@@ -85,6 +85,12 @@
 /* public functions */
 
 /**
+ * @defgroup Evas_Clip_Group Clip Functions
+ *
+ * Functions that manage the clipping of objects by other objects.
+ */
+
+/**
  * Clip one object to another.
  * @param obj The object to be clipped
  * @param clip The object to clip @p obj by
@@ -129,6 +135,8 @@
  * evas_object_clip_set(obj, clipper);
  * evas_object_show(clipper);
  * @endcode
+ *
+ * @ingroup Evas_Clip_Group
  */
 void
 evas_object_clip_set(Evas_Object *obj, Evas_Object *clip)
@@ -192,6 +200,7 @@
  * if (clipper) evas_object_show(clipper);
  * @endcode
  * 
+ * @ingroup Evas_Clip_Group
  */
 Evas_Object *
 evas_object_clip_get(Evas_Object *obj)
@@ -227,6 +236,7 @@
  *   }
  * @endcode
  * 
+ * @ingroup Evas_Clip_Group
  */
 void
 evas_object_clip_unset(Evas_Object *obj)
@@ -296,7 +306,7 @@
  *       }
  *   }
  * @endcode
- * 
+ * @ingroup Evas_Clip_Group
  */
 const Evas_List *
 evas_object_clipees_get(Evas_Object *obj)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/evas/src/lib/canvas/evas_events.c,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -3 -r1.21 -r1.22
--- evas_events.c       14 Jun 2004 06:04:22 -0000      1.21
+++ evas_events.c       16 Aug 2004 05:13:25 -0000      1.22
@@ -61,6 +61,12 @@
 /* public functions */
 
 /**
+ * @defgroup Evas_Event_Freezing_Group Evas Event Freezing Functions
+ *
+ * Functions that deal with the freezing of event processing of an evas.
+ */
+
+/**
  * Freeze alll event processing
  * @param e The canvas to freeze event processing on
  * 
@@ -79,6 +85,7 @@
  * evas_object_resize(object, 200, 200);
  * evas_event_thaw(evas);
  * @endcode
+ * @ingroup Evas_Event_Freezing_Group
  */
 void
 evas_event_freeze(Evas *e)
@@ -99,7 +106,7 @@
  * to be evaluated.
  * 
  * See evas_event_freeze() for an example.
- * 
+ * @ingroup Evas_Event_Freezing_Group
  */
 void
 evas_event_thaw(Evas *e)
@@ -128,6 +135,7 @@
  * 
  * while (evas_event_freeze_get(evas) > 0) evas_event_thaw(evas);
  * @endcode
+ * @ingroup Evas_Event_Freezing_Group
  */
 int
 evas_event_freeze_get(Evas *e)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/evas/src/lib/canvas/evas_object_gradient.c,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- evas_object_gradient.c      12 Aug 2004 12:13:59 -0000      1.5
+++ evas_object_gradient.c      16 Aug 2004 05:13:25 -0000      1.6
@@ -126,7 +126,8 @@
 
 /**
  * Deletes all colours set for the given evas gradient object.
- * @param obj The given evas gradient object.
+ * @param   obj The given evas gradient object.
+ * @ingroup Evas_Object_Gradient_Group
  */
 void
 evas_object_gradient_colors_clear(Evas_Object *obj)
@@ -153,7 +154,7 @@
  * from vertical.
  * @param   obj   The given evas gradient object.
  * @param   angle Angle in degrees.  Can be negative.
- * @ingroup Evas_Object_Gradient
+ * @ingroup Evas_Object_Gradient_Group
  */
 void
 evas_object_gradient_angle_set(Evas_Object *obj, Evas_Angle angle)
@@ -178,7 +179,7 @@
  * clockwise from the vertical.
  * @param   obj The given evas gradient object.
  * @return  The current angle if successful. @c 0.0 otherwise.
- * @ingroup Evas_Object_Gradient
+ * @ingroup Evas_Object_Gradient_Group
  */
 Evas_Angle
 evas_object_gradient_angle_get(Evas_Object *obj)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/evas/src/lib/canvas/evas_object_line.c,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -3 -r1.8 -r1.9
--- evas_object_line.c  14 Jun 2004 06:04:22 -0000      1.8
+++ evas_object_line.c  16 Aug 2004 05:13:25 -0000      1.9
@@ -62,10 +62,16 @@
 /* it has no other api calls as all properties are standard */
 
 /**
- * To be documented.
+ * @defgroup Evas_Line_Group Line Functions
  *
- * FIXME: To be fixed.
- * 
+ * Functions used to deal with evas line objects.
+ */
+
+/**
+ * Adds a new evas line object to the given evas.
+ * @param   e The given evas.
+ * @return  The new evas line object.
+ * @ingroup Evas_Line_Group
  */
 Evas_Object *
 evas_object_line_add(Evas *e)
@@ -82,10 +88,13 @@
 }
 
 /**
- * To be documented.
- *
- * FIXME: To be fixed.
- * 
+ * Sets the coordinates of the end points of the given evas line object.
+ * @param   obj The given evas line object.
+ * @param   x1  The X coordinate of the first point.
+ * @param   y1  The Y coordinate of the first point.
+ * @param   x2  The X coordinate of the second point.
+ * @param   y2  The Y coordinate of the second point.
+ * @ingroup Evas_Line_Group
  */
 void
 evas_object_line_xy_set(Evas_Object *obj, Evas_Coord x1, Evas_Coord y1, Evas_Coord 
x2, Evas_Coord y2)
@@ -154,10 +163,17 @@
 }
 
 /**
- * To be documented.
- *
- * FIXME: To be fixed.
- * 
+ * Retrieves the coordinates of the end points of the given evas line object.
+ * @param obj The given line object.
+ * @param x1  Pointer to an integer in which to store the X coordinate of the
+ *            first end point.
+ * @param y1  Pointer to an integer in which to store the Y coordinate of the
+ *            first end point.
+ * @param x2  Pointer to an integer in which to store the X coordinate of the
+ *            second end point.
+ * @param y2  Pointer to an integer in which to store the Y coordinate of the
+ *            second end point.
+ * @ingroup Evas_Line_Group
  */
 void
 evas_object_line_xy_get(Evas_Object *obj, Evas_Coord *x1, Evas_Coord *y1, Evas_Coord 
*x2, Evas_Coord *y2)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/evas/src/lib/canvas/evas_object_main.c,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -3 -r1.20 -r1.21
--- evas_object_main.c  1 Aug 2004 12:34:19 -0000       1.20
+++ evas_object_main.c  16 Aug 2004 05:13:25 -0000      1.21
@@ -396,7 +396,7 @@
 /* routines apps will call */
 
 /**
- * @defgroup Evas_Object Evas Object Functions
+ * @defgroup Evas_Object_Group Generic Object Functions
  *
  * Functions that manipulate generic evas objects.
  */
@@ -408,7 +408,8 @@
  * If the object currently has the focus, its 'focus out' callback is
  * also called.
  *
- * @param obj The given evas object.
+ * @param   obj The given evas object.
+ * @ingroup Evas_Object_Group
  */
 void
 evas_object_del(Evas_Object *obj)
@@ -444,7 +445,7 @@
  * @param   obj The given evas object.
  * @param   x   X position to move the object to, in canvas units.
  * @param   y   Y position to move the object to, in canvas units.
- * @ingroup Evas_Object
+ * @ingroup Evas_Object_Group
  */
 void
 evas_object_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y)
@@ -497,7 +498,7 @@
  * @param   obj The given evas object.
  * @param   w   The new width of the evas object.
  * @param   h   The new height of the evas object.
- * @ingroup Evas_Object
+ * @ingroup Evas_Object_Group
  */
 void
 evas_object_resize(Evas_Object *obj, Evas_Coord w, Evas_Coord h)
@@ -546,10 +547,21 @@
 }
 
 /**
- * To be documented.
+ * Retrieves the position and rectangular size of the given evas object.
  *
- * FIXME: To be fixed.
+ * Note that if any of @p x, @p y, @p w or @p h are @c NULL, the @c NULL
+ * parameters are ignored.
  * 
+ * @param obj The given evas object.
+ * @param   x   Pointer to an integer in which to store the X coordinate of
+ *              the object.
+ * @param   y   Pointer to an integer in which to store the Y coordinate of
+ *              the object.
+ * @param   w   Pointer to an integer in which to store the width of the
+ *              object.
+ * @param   h   Pointer to an integer in which to store the height of the
+ *              object.
+ * @ingroup Evas_Object_Group
  */
 void
 evas_object_geometry_get(Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord 
*w, Evas_Coord *h)
@@ -570,10 +582,15 @@
 }
 
 /**
- * To be documented.
+ * @defgroup Evas_Object_Visibility_Group Generic Object Visibility Functions
  *
- * FIXME: To be fixed.
- * 
+ * Functions that deal with the visibility of evas objects.
+ */
+
+/**
+ * Makes the given evas object visible.
+ * @param   obj The given evas object.
+ * @ingroup Evas_Object_Visibility_Group
  */
 void
 evas_object_show(Evas_Object *obj)
@@ -612,10 +629,9 @@
 }
 
 /**
- * To be documented.
- *
- * FIXME: To be fixed.
- * 
+ * Makes the given evas object invisible.
+ * @param   obj The given evas object.
+ * @ingroup Evas_Object_Visibility_Group
  */
 void
 evas_object_hide(Evas_Object *obj)
@@ -675,10 +691,10 @@
 }
 
 /**
- * To be documented.
- *
- * FIXME: To be fixed.
- * 
+ * Retrieves whether or not the given evas object is visible.
+ * @param   obj The given evas object.
+ * @return  @c 1 if the object is visible.  @c 0 otherwise.
+ * @ingroup Evas_Object_Visibility_Group
  */
 Evas_Bool
 evas_object_visible_get(Evas_Object *obj)
@@ -691,10 +707,13 @@
 }
 
 /**
- * To be documented.
- *
- * FIXME: To be fixed.
- * 
+ * Sets the general colour of the given evas object to the given colour.
+ * @param obj The given evas object.
+ * @param r   The red component of the given colour.
+ * @param g   The green component of the given colour.
+ * @param b   The blue component of the given colour.
+ * @param a   The alpha component of the given colour.
+ * @ingroup Evas_Object_Group
  */
 void
 evas_object_color_set(Evas_Object *obj, int r, int g, int b, int a)
@@ -725,10 +744,21 @@
 }
 
 /**
- * To be documented.
+ * Retrieves the general colour of the given evas object.
  *
- * FIXME: To be fixed.
- * 
+ * Note that if any of @p r, @p g, @p b or @p a are @c NULL, then the
+ * @c NULL parameters are ignored.
+ *
+ * @param   obj The given evas object.
+ * @param   r   Pointer to an integer in which to store the red component of
+ *              the colour.
+ * @param   g   Pointer to an integer in which to store the green component of
+ *              the colour.
+ * @param   b   Pointer to an integer in which to store the blue component of
+ *              the colour.
+ * @param   a   Pointer to an integer in which to store the alpha component of
+ *              the colour.
+ * @ingroup Evas_Object_Group
  */
 void
 evas_object_color_get(Evas_Object *obj, int *r, int *g, int *b, int *a)
@@ -749,10 +779,10 @@
 }
 
 /**
- * To be documented.
- *
- * FIXME: To be fixed.
- * 
+ * Retrieves the evas that the given evas object is on.
+ * @param   obj The given evas object.
+ * @return  The evas that the object is on.
+ * @ingroup Evas_Object_Group
  */
 Evas *
 evas_object_evas_get(Evas_Object *obj)
@@ -765,10 +795,17 @@
 }
 
 /**
+ * @defgroup Evas_Object_Finders Object Finder Functions
+ *
+ * Functions that determine what evas objects are at a given location
+ * or within a given region of an evas.
+ */
+
+/**
  * To be documented.
  *
  * FIXME: To be fixed.
- * 
+ * @ingroup Evas_Object_Finders
  */
 Evas_Object *
 evas_object_top_at_xy_get(Evas *e, Evas_Coord x, Evas_Coord y, Evas_Bool 
include_pass_events_objects, Evas_Bool include_hidden_objects)
@@ -808,7 +845,7 @@
  * To be documented.
  *
  * FIXME: To be fixed.
- * 
+ * @ingroup Evas_Object_Finders
  */
 Evas_Object *
 evas_object_top_at_pointer_get(Evas *e)
@@ -820,7 +857,7 @@
  * To be documented.
  *
  * FIXME: To be fixed.
- * 
+ * @ingroup Evas_Object_Finders
  */
 Evas_Object *
 evas_object_top_in_rectangle_get(Evas *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, 
Evas_Coord h, Evas_Bool include_pass_events_objects, Evas_Bool include_hidden_objects)
@@ -864,7 +901,7 @@
  * To be documented.
  *
  * FIXME: To be fixed.
- * 
+ * @ingroup Evas_Object_Finders
  */
 Evas_List *
 evas_objects_at_xy_get(Evas *e, Evas_Coord x, Evas_Coord y, Evas_Bool 
include_pass_events_objects, Evas_Bool include_hidden_objects)
@@ -905,7 +942,7 @@
  * To be documented.
  *
  * FIXME: To be fixed.
- * 
+ * @ingroup Evas_Object_Finders
  */
 Evas_List *
 evas_objects_in_rectangle_get(Evas *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, 
Evas_Coord h, Evas_Bool include_pass_events_objects, Evas_Bool include_hidden_objects)
@@ -947,10 +984,10 @@
 }
 
 /**
- * To be documented.
- *
- * FIXME: To be fixed.
- * 
+ * Retrieves the name of the type of the given evas object.
+ * @param   obj The given object.
+ * @return  The name.
+ * @ingroup Evas_Object_Group
  */
 const char *
 evas_object_type_get(Evas_Object *obj)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/evas/src/lib/canvas/evas_object_polygon.c,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -3 -r1.8 -r1.9
--- evas_object_polygon.c       14 Jun 2004 06:04:22 -0000      1.8
+++ evas_object_polygon.c       16 Aug 2004 05:13:25 -0000      1.9
@@ -59,10 +59,16 @@
 /* it has no other api calls as all properties are standard */
 
 /**
- * To be documented.
+ * @defgroup Evas_Polygon_Group Polygon Functions
  *
- * FIXME: To be fixed.
- * 
+ * Functions that operate on evas polygon objects.
+ */
+
+/**
+ * Adds a new evas polygon object to the given evas.
+ * @param   e The given evas.
+ * @return  A new evas polygon object.
+ * @ingroup Evas_Polygon_Group
  */
 Evas_Object *
 evas_object_polygon_add(Evas *e)
@@ -79,10 +85,11 @@
 }
 
 /**
- * To be documented.
- *
- * FIXME: To be fixed.
- * 
+ * Adds the given point to the given evas polygon object.
+ * @param obj The given evas polygon object.
+ * @param x   The X coordinate of the given point.
+ * @param y   The Y coordinate of the given point.
+ * @ingroup Evas_Polygon_Group
  */
 void
 evas_object_polygon_point_add(Evas_Object *obj, Evas_Coord x, Evas_Coord y)
@@ -151,10 +158,9 @@
 }
 
 /**
- * To be documented.
- *
- * FIXME: To be fixed.
- * 
+ * Removes all of the points from the given evas polygon object.
+ * @param   obj The given polygon object.
+ * @ingroup Evas_Polygon_Group
  */
 void
 evas_object_polygon_points_clear(Evas_Object *obj)




-------------------------------------------------------
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

Reply via email to