* remove \'too small\' groups (unify image and gradient groups)
authordavemds <davemds@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Sat, 1 Nov 2008 20:19:28 +0000 (20:19 +0000)
committerdavemds <davemds@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Sat, 1 Nov 2008 20:19:28 +0000 (20:19 +0000)
 * fix some modules name to be more consistent

git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/evas@37382 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

src/lib/canvas/evas_clip.c
src/lib/canvas/evas_events.c
src/lib/canvas/evas_main.c
src/lib/canvas/evas_object_gradient.c
src/lib/canvas/evas_object_gradient2_linear.c
src/lib/canvas/evas_object_gradient2_radial.c
src/lib/canvas/evas_object_image.c
src/lib/canvas/evas_object_line.c
src/lib/canvas/evas_object_main.c
src/lib/canvas/evas_object_polygon.c

index 7d86a66..4015fb1 100644 (file)
@@ -41,7 +41,7 @@ evas_object_clippers_was_visible(Evas_Object *obj)
 /* public functions */
 
 /**
- * @defgroup Evas_Clip_Group Clip Functions
+ * @defgroup Evas_Clip_Group Object Clip Functions
  *
  * Functions that manage the clipping of objects by other objects.
  */
index c6d9fe5..07b1c86 100644 (file)
@@ -986,7 +986,7 @@ evas_event_feed_hold(Evas *e, int hold, unsigned int timestamp, const void *data
 }
 
 /**
- * @defgroup Evas_Object_Event_Flags_Group Evas Object Event Flag Functions
+ * @defgroup Evas_Object_Event_Flags_Group Object Event Flag Functions
  *
  * Functions that deal with how events on an Evas Object are processed.
  */
index 0e9d747..ada1185 100644 (file)
@@ -32,7 +32,7 @@ evas_shutdown(void)
 }
 
 /**
- * @defgroup Evas_Canvas Evas Canvas
+ * @defgroup Evas_Canvas Evas Canvas functions
  *
  * Functions that deal with the basic evas object.  They are the
  * functions you need to use at a minimum to get a working evas, and
index 6b12838..b2daf75 100644 (file)
@@ -81,7 +81,7 @@ static const Evas_Object_Func object_func =
 /* the actual api call to add a gradient */
 
 /**
- * @defgroup Evas_Object_Gradient_Group Evas Gradient Object Functions
+ * @defgroup Evas_Object_Gradient_Group Gradient Object Functions
  *
  * Functions that work on evas gradient objects.
  *
@@ -280,13 +280,6 @@ evas_object_gradient_alpha_data_set(Evas_Object *obj, void *data, int len)
 }
 
 /**
- * @defgroup Evas_Object_Gradient_Fill_Group Gradient Object Fill Rectangle Functions
- *
- * Functions that deal with what areas of the gradient object are to be
- * tiled with the gradient.
- */
-
-/**
  * Sets the rectangle on the gradient object that the gradient will be
  * drawn to.
  *
@@ -304,7 +297,7 @@ evas_object_gradient_alpha_data_set(Evas_Object *obj, void *data, int len)
  * @param   y   The Y coordinate for the top left corner of the rect.
  * @param   w   The width of the rect.
  * @param   h   The height of the rect.
- * @ingroup Evas_Object_Gradient_Fill_Group
+ * @ingroup Evas_Object_Gradient_Group
  */
 EAPI void
 evas_object_gradient_fill_set(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h)
@@ -344,7 +337,7 @@ evas_object_gradient_fill_set(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas
  * @param   y   Pointer to an Evas_Coord to store the Y coordinate in.
  * @param   w   Pointer to an Evas_Coord to store the width in.
  * @param   h   Pointer to an Evas_Coord to store the height in.
- * @ingroup Evas_Object_Gradient_Fill_Group
+ * @ingroup Evas_Object_Gradient_Group
  */
 EAPI void
 evas_object_gradient_fill_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
@@ -608,20 +601,12 @@ evas_object_gradient_direction_get(const Evas_Object *obj)
 }
 
 /**
- * @defgroup Evas_Object_Gradient_Type_Group Gradient Object Type Functions
- *
- * Functions that set or get a gradient's geometric type. Examples are "linear",
- * "linear.diag", "linear.codiag", "radial", "rectangular", "angular", "sinusoidal", ...
- * Some types may accept additional parameters to further specify the look.
- */
-
-/**
  * Sets the geometric type displayed by the given gradient object.
  * @param   obj  The given gradient object.
  * @param   name Name of the geometric type that the gradient is to be drawn as.
  * @param   params List of allowable params that the given gradient type allows.
  * Can be NULL.
- * @ingroup Evas_Object_Gradient_Type_Group
+ * @ingroup Evas_Object_Gradient_Group
  */
 EAPI void
 evas_object_gradient_type_set(Evas_Object *obj, const char *name, const char *params)
@@ -695,7 +680,7 @@ evas_object_gradient_type_set(Evas_Object *obj, const char *name, const char *pa
  *               name in.
  * @param   params  Pointer to a character pointer to store the pointer to the type
  *               params string in.
- * @ingroup Evas_Object_Gradient_Type_Group
+ * @ingroup Evas_Object_Gradient_Group
  */
 EAPI void
 evas_object_gradient_type_get(const Evas_Object *obj, char **name, char **params)
index bebdeee..ffa0591 100644 (file)
@@ -66,14 +66,6 @@ static const Evas_Object_Func object_func =
 /* the actual api call to add a gradient */
 
 /**
- * @defgroup Evas_Object_Gradient_Linear_Group Evas linear_gradient Object Functions
- *
- * Functions that work on evas linear gradient objects.
- *
- * The following example shows how
- */
-
-/**
  * Adds a gradient object to the given evas.
  * @param   e The given evas.
  * @return  A new evas gradient object if successful.  Otherwise, @c NULL.
@@ -99,11 +91,6 @@ evas_object_gradient2_linear_add(Evas *e)
    return obj;
 }
 
-/**
- * @defgroup Evas_Object_Gradient_Linear_Fill_Group Linear_Gradient Object Fill Functions
- *
- * Functions that deal with the fill geometry of the linear gradient object.
- */
 
 /**
  * Sets the start and end points of the linear gradient geometry for the object.
@@ -120,7 +107,7 @@ evas_object_gradient2_linear_add(Evas *e)
  * @param   y0   The Y coordinate of the start point.
  * @param   x1   The X coordinate of the end point.
  * @param   y1   The Y coordinate of the end point
- * @ingroup Evas_Object_Gradient_Linear_Fill_Group
+ * @ingroup Evas_Object_Gradient_Group
  */
 EAPI void
 evas_object_gradient2_linear_fill_set(Evas_Object *obj, float x0, float y0, float x1, float y1)
index f721ef9..ea646ad 100644 (file)
@@ -66,14 +66,6 @@ static const Evas_Object_Func rg_object_func =
 /* the actual api call to add a gradient */
 
 /**
- * @defgroup Evas_Object_Gradient_Radial_Group Evas radial_gradient Object Functions
- *
- * Functions that work on evas radial gradient objects.
- *
- * The following example shows how
- */
-
-/**
  * Adds a gradient object to the given evas.
  * @param   e The given evas.
  * @return  A new evas gradient object if successful.  Otherwise, @c NULL.
@@ -100,12 +92,6 @@ evas_object_gradient2_radial_add(Evas *e)
 }
 
 /**
- * @defgroup Evas_Object_Gradient_Radial_Fill_Group Radial_Gradient Object Fill Functions
- *
- * Functions that deal with the fill geometry of the radial gradient object.
- */
-
-/**
  * Sets the center and radii of the radial gradient geometry for the object.
  *
  * Note that the gradient may extend beyond these,
@@ -120,7 +106,7 @@ evas_object_gradient2_radial_add(Evas *e)
  * @param   cy   The Y coordinate of the start point.
  * @param   rx   The length of the x-cordinate radius.
  * @param   ry   The length of the y-coordinate radius.
- * @ingroup Evas_Object_Gradient_Radial_Fill_Group
+ * @ingroup Evas_Object_Gradient_Group
  */
 EAPI void
 evas_object_gradient2_radial_fill_set(Evas_Object *obj, float cx, float cy, float rx, float ry)
index 9784f50..ae8fa33 100644 (file)
@@ -206,12 +206,6 @@ evas_object_image_add(Evas *e)
 }
 
 /**
- * @defgroup Evas_Object_Image_File_Group Image Object File Functions
- *
- * Functions that write to or retrieve images from files.
- */
-
-/**
  * Sets the filename and key of the given image object.
  *
  * If the file supports multiple data stored in it as eet,
@@ -221,7 +215,7 @@ evas_object_image_add(Evas *e)
  * @param obj The given image object.
  * @param file The image filename.
  * @param key The image key in file, or NULL.
- * @ingroup Evas_Object_Image_File_Group
+ * @ingroup Evas_Object_Image
  */
 EAPI void
 evas_object_image_file_set(Evas_Object *obj, const char *file, const char *key)
@@ -303,7 +297,7 @@ evas_object_image_file_set(Evas_Object *obj, const char *file, const char *key)
  * @param obj The given image object.
  * @param file Location to store the image filename, or NULL.
  * @param key Location to store the image key, or NULL.
- * @ingroup Evas_Object_Image_File_Group
+ * @ingroup Evas_Object_Image
  */
 EAPI void
 evas_object_image_file_get(const Evas_Object *obj, const char **file, const char **key)
@@ -326,12 +320,6 @@ evas_object_image_file_get(const Evas_Object *obj, const char **file, const char
 }
 
 /**
- * @defgroup Evas_Object_Image_Border_Group Image Object Border Functions
- *
- * Functions that adjust the unscaled image border of image objects.
- */
-
-/**
  * Sets how much of each border of the given image object is not
  * to be scaled.
  *
@@ -348,7 +336,7 @@ evas_object_image_file_get(const Evas_Object *obj, const char **file, const char
  * @param r Distance of the right border that is not to be stretched.
  * @param t Distance of the top border that is not to be stretched.
  * @param b Distance of the bottom border that is not to be stretched.
- * @ingroup Evas_Object_Image_Border_Group
+ * @ingroup Evas_Object_Image
  */
 EAPI void
 evas_object_image_border_set(Evas_Object *obj, int l, int r, int t, int b)
@@ -389,7 +377,7 @@ evas_object_image_border_set(Evas_Object *obj, int l, int r, int t, int b)
  * @param r Location to store the right border width in, or NULL.
  * @param t Location to store the top border width in, or NULL.
  * @param b Location to store the bottom border width in, or NULL.
- * @ingroup Evas_Object_Image_Border_Group
+ * @ingroup Evas_Object_Image
  */
 EAPI void
 evas_object_image_border_get(const Evas_Object *obj, int *l, int *r, int *t, int *b)
@@ -418,13 +406,6 @@ evas_object_image_border_get(const Evas_Object *obj, int *l, int *r, int *t, int
 }
 
 /**
- * @defgroup Evas_Object_Image_Fill_Group Image Object Fill Rectangle Functions
- *
- * Functions that deal with what areas of the image object are to be
- * tiled with the given image.
- */
-
-/**
  * Sets if the center part of the given image object (not the border)
  * should be drawn.
  *
@@ -435,7 +416,7 @@ evas_object_image_border_get(const Evas_Object *obj, int *l, int *r, int *t, int
  *
  * @param obj The given image object.
  * @param fill Whether the center should be drawn.
- * @ingroup Evas_Object_Image_Fill_Group
+ * @ingroup Evas_Object_Image
  */
 EAPI void
 evas_object_image_border_center_fill_set(Evas_Object *obj, Evas_Bool fill)
@@ -465,7 +446,7 @@ evas_object_image_border_center_fill_set(Evas_Object *obj, Evas_Bool fill)
  *
  * @param obj The given image object.
  * @return If the center is to be drawn or not.
- * @ingroup Evas_Object_Image_Fill_Group
+ * @ingroup Evas_Object_Image
  */
 EAPI Evas_Bool
 evas_object_image_border_center_fill_get(const Evas_Object *obj)
@@ -499,7 +480,7 @@ evas_object_image_border_center_fill_get(const Evas_Object *obj)
  * @param y The Y coordinate for the top left corner of the image.
  * @param w The width of the image.
  * @param h The height of the image.
- * @ingroup Evas_Object_Image_Fill_Group
+ * @ingroup Evas_Object_Image
  */
 EAPI void
 evas_object_image_fill_set(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h)
@@ -540,7 +521,7 @@ evas_object_image_fill_set(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Co
  * @param y Location to store the Y coordinate for the top left corner of the image in, or NULL.
  * @param w Location to store the width of the image in, or NULL.
  * @param h Location to store the height of the image in, or NULL.
- * @ingroup Evas_Object_Image_Fill_Group
+ * @ingroup Evas_Object_Image
  */
 EAPI void
 evas_object_image_fill_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
@@ -574,7 +555,7 @@ evas_object_image_fill_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y,
  * @param   obj   The given evas image object.
  * @param   spread One of EVAS_TEXTURE_REFLECT, EVAS_TEXTURE_REPEAT,
  * EVAS_TEXTURE_RESTRICT, or EVAS_TEXTURE_PAD.
- * @ingroup Evas_Object_Image_Fill_Group
+ * @ingroup Evas_Object_Image
  */
 EAPI void
 evas_object_image_fill_spread_set(Evas_Object *obj, int spread)
@@ -598,7 +579,7 @@ evas_object_image_fill_spread_set(Evas_Object *obj, int spread)
  * Retrieves the spread (tiling mode) for the given image object's fill.
  * @param   obj The given evas image object.
  * @return  The current spread mode of the image object.
- * @ingroup Evas_Object_Image_Fill_Group
+ * @ingroup Evas_Object_Image
  */
 EAPI int
 evas_object_image_fill_spread_get(const Evas_Object *obj)
@@ -695,12 +676,6 @@ evas_object_image_fill_transform_get (const Evas_Object *obj, Evas_Transform *t)
 }
 
 /**
- * @defgroup Evas_Object_Image_Size Image Object Image Size Functions
- *
- * Functions that change the size of the image used by an image object.
- */
-
-/**
  * Sets the size of the given image object.
  *
  * This function will scale down or crop the image so that it is
@@ -712,7 +687,7 @@ evas_object_image_fill_transform_get (const Evas_Object *obj, Evas_Transform *t)
  * @param obj The given image object.
  * @param w The new width of the image.
  * @param h The new height of the image.
- * @ingroup Evas_Object_Image_Size
+ * @ingroup Evas_Object_Image
  */
 EAPI void
 evas_object_image_size_set(Evas_Object *obj, int w, int h)
@@ -770,7 +745,7 @@ evas_object_image_size_set(Evas_Object *obj, int w, int h)
  * @param obj The given image object.
  * @param w Location to store the width of the image in, or NULL.
  * @param h Location to store the height of the image in, or NULL.
- * @ingroup Evas_Object_Image_Size
+ * @ingroup Evas_Object_Image
  */
 EAPI void
 evas_object_image_size_get(const Evas_Object *obj, int *w, int *h)
@@ -800,7 +775,7 @@ evas_object_image_size_get(const Evas_Object *obj, int *w, int *h)
  *
  * @param obj The given image object.
  * @return The stride of the image.
- * @ingroup Evas_Object_Image_Size
+ * @ingroup Evas_Object_Image
  */
 EAPI int
 evas_object_image_stride_get(const Evas_Object *obj)
@@ -843,13 +818,6 @@ evas_object_image_load_error_get(const Evas_Object *obj)
 }
 
 /**
- * @defgroup Evas_Object_Image_Data Image Object Image Data Functions
- *
- * Functions that allow you to access or modify the image pixel data of an
- * image object.
- */
-
-/**
  * Converts the raw image data of the given image object to the
  * specified colorspace.
  *
@@ -864,7 +832,7 @@ evas_object_image_load_error_get(const Evas_Object *obj)
  * @param obj The given image object.
  * @param to_cspace The colorspace to which the image raw data will be converted.
  * @return data A newly allocated data in the format specified by to_cspace.
- * @ingroup Evas_Object_Image_Data
+ * @ingroup Evas_Object_Image
  */
 EAPI void *
 evas_object_image_data_convert(Evas_Object *obj, Evas_Colorspace to_cspace)
@@ -897,7 +865,7 @@ evas_object_image_data_convert(Evas_Object *obj, Evas_Colorspace to_cspace)
  *
  * @param obj The given image object.
  * @param data The raw data, or NULL.
- * @ingroup Evas_Object_Image_Data
+ * @ingroup Evas_Object_Image
  */
 EAPI void
 evas_object_image_data_set(Evas_Object *obj, void *data)
@@ -967,7 +935,7 @@ evas_object_image_data_set(Evas_Object *obj, void *data)
  * @param obj The given image object.
  * @param for_writing Whether the data being retrieved will be modified.
  * @return The raw image data.
- * @ingroup Evas_Object_Image_Data
+ * @ingroup Evas_Object_Image
  */
 EAPI void *
 evas_object_image_data_get(const Evas_Object *obj, Evas_Bool for_writing)
@@ -1007,7 +975,7 @@ evas_object_image_data_get(const Evas_Object *obj, Evas_Bool for_writing)
  *
  * @param obj The given image object.
  * @param cancel 0 means add to the workqueue, 1 remove it.
- * @ingroup Evas_Object_Image_Data
+ * @ingroup Evas_Object_Image
  */
 EAPI void
 evas_object_image_preload(const Evas_Object *obj, Evas_Bool cancel)
@@ -1052,7 +1020,7 @@ evas_object_image_preload(const Evas_Object *obj, Evas_Bool cancel)
  *
  * @param obj The given image object.
  * @param data The raw data.
- * @ingroup Evas_Object_Image_Data
+ * @ingroup Evas_Object_Image
  */
 EAPI void
 evas_object_image_data_copy_set(Evas_Object *obj, void *data)
@@ -1097,7 +1065,7 @@ evas_object_image_data_copy_set(Evas_Object *obj, void *data)
  * @param y Y-offset of the region to be updated.
  * @param w Width of the region to be updated.
  * @param h Height of the region to be updated.
- * @ingroup Evas_Object_Image_Data
+ * @ingroup Evas_Object_Image
  */
 EAPI void
 evas_object_image_data_update_add(Evas_Object *obj, int x, int y, int w, int h)
@@ -1121,12 +1089,6 @@ evas_object_image_data_update_add(Evas_Object *obj, int x, int y, int w, int h)
 }
 
 /**
- * @defgroup Evas_Object_Image_Alpha Image Object Image Alpha Functions
- *
- * Functions that change the alpha of an image object.
- */
-
-/**
  * Enable or disable alpha channel of the given image object.
  *
  * This function sets a flag on an image object indicating whether or not to
@@ -1137,7 +1099,7 @@ evas_object_image_data_update_add(Evas_Object *obj, int x, int y, int w, int h)
  *
  * @param obj The given image object.
  * @param has_alpha Whether to use alpha channel data or not.
- * @ingroup Evas_Object_Image_Alpha
+ * @ingroup Evas_Object_Image
  */
 EAPI void
 evas_object_image_alpha_set(Evas_Object *obj, Evas_Bool has_alpha)
@@ -1174,7 +1136,7 @@ evas_object_image_alpha_set(Evas_Object *obj, Evas_Bool has_alpha)
  *
  * @param obj The given image object.
  * @return Whether the alpha channel data is being used.
- * @ingroup Evas_Object_Image_Alpha
+ * @ingroup Evas_Object_Image
  */
 EAPI Evas_Bool
 evas_object_image_alpha_get(const Evas_Object *obj)
@@ -1192,12 +1154,6 @@ evas_object_image_alpha_get(const Evas_Object *obj)
 }
 
 /**
- * @defgroup Evas_Object_Image_Scale Image Object Image Scaling Functions
- *
- * Functions that change the scaling quality of an image object.
- */
-
-/**
  * Sets whether to use of high-quality image scaling algorithm
  * of the given image object.
  *
@@ -1207,7 +1163,7 @@ evas_object_image_alpha_get(const Evas_Object *obj)
  *
  * @param obj The given image object.
  * @param smooth_scale Whether to use smooth scale or not.
- * @ingroup Evas_Object_Image_Scale
+ * @ingroup Evas_Object_Image
  */
 EAPI void
 evas_object_image_smooth_scale_set(Evas_Object *obj, Evas_Bool smooth_scale)
@@ -1235,7 +1191,7 @@ evas_object_image_smooth_scale_set(Evas_Object *obj, Evas_Bool smooth_scale)
  *
  * @param obj The given image object.
  * @return Whether smooth scale is being used.
- * @ingroup Evas_Object_Image_Scale
+ * @ingroup Evas_Object_Image
  */
 EAPI Evas_Bool
 evas_object_image_smooth_scale_get(const Evas_Object *obj)
index 9d7afc5..b57ea14 100644 (file)
@@ -69,7 +69,7 @@ static const Evas_Object_Func object_func =
 /* it has no other api calls as all properties are standard */
 
 /**
- * @defgroup Evas_Line_Group Line Functions
+ * @defgroup Evas_Line_Group Line Object Functions
  *
  * Functions used to deal with evas line objects.
  */
index 6bae7c3..c10ee8c 100644 (file)
@@ -999,15 +999,9 @@ evas_object_size_hint_padding_set(Evas_Object *obj, Evas_Coord l, Evas_Coord r,
 }
 
 /**
- * @defgroup Evas_Object_Visibility_Group Generic Object Visibility Functions
- *
- * 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
+ * @ingroup Evas_Object_Group
  */
 EAPI void
 evas_object_show(Evas_Object *obj)
@@ -1054,7 +1048,7 @@ evas_object_show(Evas_Object *obj)
 /**
  * Makes the given evas object invisible.
  * @param   obj The given evas object.
- * @ingroup Evas_Object_Visibility_Group
+ * @ingroup Evas_Object_Group
  */
 EAPI void
 evas_object_hide(Evas_Object *obj)
@@ -1142,7 +1136,7 @@ evas_object_hide(Evas_Object *obj)
  * 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
+ * @ingroup Evas_Object_Group
  */
 EAPI Evas_Bool
 evas_object_visible_get(const Evas_Object *obj)
index 716720f..bfb1663 100644 (file)
@@ -66,7 +66,7 @@ static const Evas_Object_Func object_func =
 /* it has no other api calls as all properties are standard */
 
 /**
- * @defgroup Evas_Polygon_Group Polygon Functions
+ * @defgroup Evas_Polygon_Group Polygon Object Functions
  *
  * Functions that operate on evas polygon objects.
  */