enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 1 Projects Releases Wiki Activity

* More better cats\' 

* remove some @ingroup in favor of @addtogroup

SVN revision: 37386
This commit is contained in:
Davide Andreoli 2008-11-01 21:50:36 +00:00
parent 08ca0e43c0
commit f526e28ac0
18 changed files with 110 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
legacy/evas/src/lib/canvas/evas_callbacks.c
View File

@ -154,6 +154,12 @@ evas_object_event_callback_call(Evas_Object *obj, Evas_Callback_Type type, void
* Functions that add and remove callbacks to evas objects.
*/
/**
* @addtogroup Evas_Object_Callback_Group
* @{
* @ingroup Evas_Object_Group
*/
/**
* @todo Move this next code example and most of the documentation for
* this next function into the group documentation.
@ -316,7 +322,6 @@ evas_object_event_callback_call(Evas_Object *obj, Evas_Callback_Type type, void
* exit(-1);
* }
* @endcode
* @ingroup Evas_Object_Callback_Group
*/
EAPI 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)
@ -369,7 +374,6 @@ evas_object_event_callback_add(Evas_Object *obj, Evas_Callback_Type type, void (
*
* my_data = evas_object_event_callback_del(object, EVAS_CALLBACK_MOUSE_UP, up_callback);
* @endcode
* @ingroup Evas_Object_Callback_Group
*/
EAPI 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))
@ -426,7 +430,6 @@ evas_object_event_callback_del(Evas_Object *obj, Evas_Callback_Type type, void (
*
* my_data = evas_object_event_callback_del_full(object, EVAS_CALLBACK_MOUSE_UP, up_callback, data);
* @endcode
* @ingroup Evas_Object_Callback_Group
*/
EAPI void *
evas_object_event_callback_del_full(Evas_Object *obj, Evas_Callback_Type type, void (*func) (void *data, Evas *e, Evas_Object *obj, void *event_info), const void *data)
@ -458,3 +461,7 @@ evas_object_event_callback_del_full(Evas_Object *obj, Evas_Callback_Type type, v
}
return NULL;
}
/**
* @}
*/

14
legacy/evas/src/lib/canvas/evas_clip.c
View File

@ -46,6 +46,12 @@ evas_object_clippers_was_visible(Evas_Object *obj)
* Functions that manage the clipping of objects by other objects.
*/
/**
* @addtogroup Evas_Clip_Group
* @{
* @ingroup Evas_Object_Group
*/
/**
* Clip one object to another.
* @param obj The object to be clipped
@ -92,7 +98,6 @@ evas_object_clippers_was_visible(Evas_Object *obj)
* evas_object_show(clipper);
* @endcode
*
* @ingroup Evas_Clip_Group
*/
EAPI void
evas_object_clip_set(Evas_Object *obj, Evas_Object *clip)
@ -174,7 +179,6 @@ evas_object_clip_set(Evas_Object *obj, Evas_Object *clip)
* if (clipper) evas_object_show(clipper);
* @endcode
*
* @ingroup Evas_Clip_Group
*/
EAPI Evas_Object *
evas_object_clip_get(const Evas_Object *obj)
@ -210,7 +214,6 @@ evas_object_clip_get(const Evas_Object *obj)
* }
* @endcode
*
* @ingroup Evas_Clip_Group
*/
EAPI void
evas_object_clip_unset(Evas_Object *obj)
@ -286,7 +289,6 @@ evas_object_clip_unset(Evas_Object *obj)
* evas_object_show(obj_tmp);
* }
* @endcode
* @ingroup Evas_Clip_Group
*/
EAPI const Eina_List *
evas_object_clipees_get(const Evas_Object *obj)
@ -296,3 +298,7 @@ evas_object_clipees_get(const Evas_Object *obj)
MAGIC_CHECK_END();
return obj->clip.clipees;
}
/**
* @}
*/

13
legacy/evas/src/lib/canvas/evas_data.c
View File

@ -8,6 +8,12 @@
* object.
*/
/**
* @addtogroup Evas_Object_Data_Group
* @{
* @ingroup Evas_Object_Group
*/
/**
* Set an attached data pointer to an object with a given string key.
* @param obj The object to attach the data pointer to
@ -38,7 +44,6 @@
* 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
*/
EAPI void
evas_object_data_set(Evas_Object *obj, const char *key, const void *data)
@ -84,7 +89,6 @@ evas_object_data_set(Evas_Object *obj, const char *key, const void *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
*/
EAPI void *
evas_object_data_get(const Evas_Object *obj, const char *key)
@ -129,7 +133,6 @@ evas_object_data_get(const Evas_Object *obj, const char *key)
*
* my_data = evas_object_data_del(obj, "name_of_my_data");
* @endcode
* @ingroup Evas_Object_Data_Group
*/
EAPI void *
evas_object_data_del(Evas_Object *obj, const char *key)
@ -155,3 +158,7 @@ evas_object_data_del(Evas_Object *obj, const char *key)
}
return NULL;
}
/**
* @}
*/

10
legacy/evas/src/lib/canvas/evas_events.c
View File

@ -991,6 +991,12 @@ evas_event_feed_hold(Evas *e, int hold, unsigned int timestamp, const void *data
* Functions that deal with how events on an Evas Object are processed.
*/
/**
* @addtogroup Evas_Object_Event_Flags_Group
* @{
* @ingroup Evas_Object_Group
*/
/**
* Set an object's pass events state.
* @param obj the evas object
@ -1136,6 +1142,10 @@ evas_object_propagate_events_get(const Evas_Object *obj)
return !(obj->no_propagate);
}
/**
* @}
*/
/**
* Set pointer behavior.
*

12
legacy/evas/src/lib/canvas/evas_layer.c
View File

@ -123,11 +123,16 @@ evas_layer_del(Evas_Layer *lay)
* @todo Document which way layers go.
*/
/**
* @addtogroup Evas_Object_Layer_Group
* @{
* @ingroup Evas_Object_Group
*/
/**
* 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
*/
EAPI void
evas_object_layer_set(Evas_Object *obj, short l)
@ -176,7 +181,6 @@ evas_object_layer_set(Evas_Object *obj, short l)
* 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
*/
EAPI short
evas_object_layer_get(const Evas_Object *obj)
@ -190,3 +194,7 @@ evas_object_layer_get(const Evas_Object *obj)
}
return obj->cur.layer;
}
/**
* @}
*/

13
legacy/evas/src/lib/canvas/evas_name.c
View File

@ -7,11 +7,16 @@
* Functions that retrieve and set the name of an evas object.
*/
/**
* @addtogroup Evas_Object_Name_Group
* @{
* @ingroup Evas_Object_Group
*/
/**
* 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
*/
EAPI void
evas_object_name_set(Evas_Object *obj, const char *name)
@ -37,7 +42,6 @@ evas_object_name_set(Evas_Object *obj, const char *name)
* @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
*/
EAPI const char *
evas_object_name_get(const Evas_Object *obj)
@ -54,7 +58,6 @@ evas_object_name_get(const Evas_Object *obj)
* @param name The given name.
* @return If successful, the evas object with the given name. Otherwise,
* @c NULL.
* @ingroup Evas_Object_Name_Group
*/
EAPI Evas_Object *
evas_object_name_find(const Evas *e, const char *name)
@ -65,3 +68,7 @@ evas_object_name_find(const Evas *e, const char *name)
if (!name) return NULL;
return (Evas_Object *)evas_hash_find(e->name_hash, name);
}
/**
* @}
*/

9
legacy/evas/src/lib/canvas/evas_object_gradient.c
View File

@ -88,10 +88,17 @@ static const Evas_Object_Func object_func =
* The following example shows how
*/
/**
* @defgroup Evas_Object_Specific Specific Object Functions
*
* Functions that work on specific objects.
*
*/
/**
* @addtogroup Evas_Object_Gradient_Group
* @{
* @ingroup Evas_Object_Group
* @ingroup Evas_Object_Specific
*/
/**

2
legacy/evas/src/lib/canvas/evas_object_gradient2.c
View File

@ -30,7 +30,7 @@ struct _Evas_Object_Gradient2
/**
* @addtogroup Evas_Object_Gradient2_Group
* @{
* @ingroup Evas_Object_Group
* @ingroup Evas_Object_Specific
*/
/**

2
legacy/evas/src/lib/canvas/evas_object_gradient2_linear.c
View File

@ -68,7 +68,7 @@ static const Evas_Object_Func object_func =
/**
* @addtogroup Evas_Object_Gradient2_Group
* @{
* @ingroup Evas_Object_Group
* @ingroup Evas_Object_Specific
*/
/**

2
legacy/evas/src/lib/canvas/evas_object_gradient2_radial.c
View File

@ -68,7 +68,7 @@ static const Evas_Object_Func rg_object_func =
/**
* @addtogroup Evas_Object_Gradient2_Group
* @{
* @ingroup Evas_Object_Group
* @ingroup Evas_Object_Specific
*/
/**

2
legacy/evas/src/lib/canvas/evas_object_image.c
View File

@ -183,7 +183,7 @@ static const Evas_Object_Func object_func =
/**
* @addtogroup Evas_Object_Image
* @{
* @ingroup Evas_Object_Group
* @ingroup Evas_Object_Specific
*/
/**

2
legacy/evas/src/lib/canvas/evas_object_line.c
View File

@ -77,7 +77,7 @@ static const Evas_Object_Func object_func =
/**
* @addtogroup Evas_Line_Group
* @{
* @ingroup Evas_Object_Group
* @ingroup Evas_Object_Specific
*/
/**

46
legacy/evas/src/lib/canvas/evas_object_main.c
View File

@ -580,10 +580,17 @@ evas_object_geometry_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, E
}
/**
* @defgroup Evas_Object_Size_Hints_Group Generic Object Size Hints Functions
* @defgroup Evas_Object_Size_Hints_Group Object Size Hints Functions
*
* Functions that deals with hints about object size.
*/
/**
* @addtogroup Evas_Object_Size_Hints_Group
* @{
* @ingroup Evas_Object_Group
*/
static void
_evas_object_size_hint_alloc(Evas_Object *obj)
{
@ -608,7 +615,6 @@ _evas_object_size_hint_alloc(Evas_Object *obj)
* @param obj The given evas object.
* @param w Pointer to an integer in which to store the minimum width.
* @param h Pointer to an integer in which to store the minimum height.
* @ingroup Evas_Object_Size_Hints_Group
*/
EAPI void
evas_object_size_hint_min_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h)
@ -635,7 +641,6 @@ evas_object_size_hint_min_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord
* @param obj The given evas object.
* @param w Integer to use as the minimum width hint.
* @param h Integer to use as the minimum height hint.
* @ingroup Evas_Object_Size_Hints_Group
*/
EAPI void
evas_object_size_hint_min_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h)
@ -665,7 +670,6 @@ evas_object_size_hint_min_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h)
* @param obj The given evas object.
* @param w Pointer to an integer in which to store the maximum width.
* @param h Pointer to an integer in which to store the maximum height.
* @ingroup Evas_Object_Size_Hints_Group
*/
EAPI void
evas_object_size_hint_max_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h)
@ -692,7 +696,6 @@ evas_object_size_hint_max_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord
* @param obj The given evas object.
* @param w Integer to use as the maximum width hint.
* @param h Integer to use as the maximum height hint.
* @ingroup Evas_Object_Size_Hints_Group
*/
EAPI void
evas_object_size_hint_max_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h)
@ -722,7 +725,6 @@ evas_object_size_hint_max_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h)
* @param obj The given evas object.
* @param w Pointer to an integer in which to store the requested width.
* @param h Pointer to an integer in which to store the requested height.
* @ingroup Evas_Object_Size_Hints_Group
*/
EAPI void
evas_object_size_hint_request_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h)
@ -749,7 +751,6 @@ evas_object_size_hint_request_get(const Evas_Object *obj, Evas_Coord *w, Evas_Co
* @param obj The given evas object.
* @param w Integer to use as the preferred width hint.
* @param h Integer to use as the preferred height hint.
* @ingroup Evas_Object_Size_Hints_Group
*/
EAPI void
evas_object_size_hint_request_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h)
@ -780,7 +781,6 @@ evas_object_size_hint_request_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h)
* @param aspect Returns the hint on how size should be calculated.
* @param w Pointer to an integer in which to store the aspect width.
* @param h Pointer to an integer in which to store the aspect height.
* @ingroup Evas_Object_Size_Hints_Group
*/
EAPI void
evas_object_size_hint_aspect_get(const Evas_Object *obj, Evas_Aspect_Control *aspect, Evas_Coord *w, Evas_Coord *h)
@ -811,7 +811,6 @@ evas_object_size_hint_aspect_get(const Evas_Object *obj, Evas_Aspect_Control *as
* @param aspect Hint on how to calculate size.
* @param w Integer to use as aspect width hint.
* @param h Integer to use as aspect height hint.
* @ingroup Evas_Object_Size_Hints_Group
*/
EAPI void
evas_object_size_hint_aspect_set(Evas_Object *obj, Evas_Aspect_Control aspect, Evas_Coord w, Evas_Coord h)
@ -839,7 +838,6 @@ evas_object_size_hint_aspect_set(Evas_Object *obj, Evas_Aspect_Control aspect, E
* @param obj The given evas object.
* @param w Pointer to a double in which to store the align x.
* @param h Pointer to a double in which to store the align y.
* @ingroup Evas_Object_Size_Hints_Group
*/
EAPI void
evas_object_size_hint_align_get(const Evas_Object *obj, double *x, double *y)
@ -866,7 +864,6 @@ evas_object_size_hint_align_get(const Evas_Object *obj, double *x, double *y)
* @param obj The given evas object.
* @param x Double (0.0-1.0) to use as align x hint.
* @param y Double (0.0-1.0) to use as align y hint.
* @ingroup Evas_Object_Size_Hints_Group
*/
EAPI void
evas_object_size_hint_align_set(Evas_Object *obj, double x, double y)
@ -893,7 +890,6 @@ evas_object_size_hint_align_set(Evas_Object *obj, double x, double y)
* @param obj The given evas object.
* @param w Pointer to a double in which to store the weight x.
* @param h Pointer to a double in which to store the weight y.
* @ingroup Evas_Object_Size_Hints_Group
*/
EAPI void
evas_object_size_hint_weight_get(const Evas_Object *obj, double *x, double *y)
@ -920,7 +916,6 @@ evas_object_size_hint_weight_get(const Evas_Object *obj, double *x, double *y)
* @param obj The given evas object.
* @param x Double (0.0-1.0) to use as weight x hint.
* @param y Double (0.0-1.0) to use as weight y hint.
* @ingroup Evas_Object_Size_Hints_Group
*/
EAPI void
evas_object_size_hint_weight_set(Evas_Object *obj, double x, double y)
@ -947,7 +942,6 @@ evas_object_size_hint_weight_set(Evas_Object *obj, double x, double y)
* @param obj The given evas object.
* @param w Pointer to a double in which to store the padding x.
* @param h Pointer to a double in which to store the padding y.
* @ingroup Evas_Object_Size_Hints_Group
*/
EAPI void
evas_object_size_hint_padding_get(const Evas_Object *obj, Evas_Coord *l, Evas_Coord *r, Evas_Coord *t, Evas_Coord *b)
@ -978,7 +972,6 @@ evas_object_size_hint_padding_get(const Evas_Object *obj, Evas_Coord *l, Evas_Co
* @param obj The given evas object.
* @param x Double (0.0-1.0) to use as padding x hint.
* @param y Double (0.0-1.0) to use as padding y hint.
* @ingroup Evas_Object_Size_Hints_Group
*/
EAPI void
evas_object_size_hint_padding_set(Evas_Object *obj, Evas_Coord l, Evas_Coord r, Evas_Coord t, Evas_Coord b)
@ -998,6 +991,11 @@ evas_object_size_hint_padding_set(Evas_Object *obj, Evas_Coord l, Evas_Coord r,
evas_object_inform_call_changed_size_hints(obj);
}
/**
* @}
*/
/**
* Makes the given evas object visible.
* @param obj The given evas object.
@ -1388,11 +1386,16 @@ evas_object_evas_get(const Evas_Object *obj)
* or within a given region of an evas.
*/
/**
* @addtogroup Evas_Object_Finders
* @{
* @ingroup Evas_Object_Group
*/
/**
* To be documented.
*
* FIXME: To be fixed.
* @ingroup Evas_Object_Finders
*/
EAPI Evas_Object *
evas_object_top_at_xy_get(const Evas *e, Evas_Coord x, Evas_Coord y, Evas_Bool include_pass_events_objects, Evas_Bool include_hidden_objects)
@ -1429,7 +1432,6 @@ evas_object_top_at_xy_get(const Evas *e, Evas_Coord x, Evas_Coord y, Evas_Bool i
* To be documented.
*
* FIXME: To be fixed.
* @ingroup Evas_Object_Finders
*/
EAPI Evas_Object *
evas_object_top_at_pointer_get(const Evas *e)
@ -1442,7 +1444,6 @@ evas_object_top_at_pointer_get(const Evas *e)
* To be documented.
*
* FIXME: To be fixed.
* @ingroup Evas_Object_Finders
*/
EAPI Evas_Object *
evas_object_top_in_rectangle_get(const 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)
@ -1485,7 +1486,6 @@ evas_object_top_in_rectangle_get(const Evas *e, Evas_Coord x, Evas_Coord y, Evas
* To be documented.
*
* FIXME: To be fixed.
* @ingroup Evas_Object_Finders
*/
EAPI Eina_List *
evas_objects_at_xy_get(const Evas *e, Evas_Coord x, Evas_Coord y, Evas_Bool include_pass_events_objects, Evas_Bool include_hidden_objects)
@ -1523,7 +1523,6 @@ evas_objects_at_xy_get(const Evas *e, Evas_Coord x, Evas_Coord y, Evas_Bool incl
* To be documented.
*
* FIXME: To be fixed.
* @ingroup Evas_Object_Finders
*/
EAPI Eina_List *
evas_objects_in_rectangle_get(const 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)
@ -1567,7 +1566,6 @@ evas_objects_in_rectangle_get(const Evas *e, Evas_Coord x, Evas_Coord y, Evas_Co
* Retrieves the name of the type of the given evas object.
* @param obj The given object.
* @return The name.
* @ingroup Evas_Object_Group
*/
EAPI const char *
evas_object_type_get(const Evas_Object *obj)
@ -1584,7 +1582,6 @@ evas_object_type_get(const Evas_Object *obj)
* @param obj The given object.
* @param precise wheter to use a precise point collision detection or not
* The default value is false.
* @ingroup Evas_Object_Group
*/
EAPI void
evas_object_precise_is_inside_set(Evas_Object *obj, Evas_Bool precise)
@ -1598,7 +1595,6 @@ evas_object_precise_is_inside_set(Evas_Object *obj, Evas_Bool precise)
/**
* Determine whether an object is set to use a precise point collision detection.
* @param obj The given object.
* @ingroup Evas_Object_Group
*/
EAPI Evas_Bool
evas_object_precise_is_inside_get(const Evas_Object *obj)
@ -1608,3 +1604,7 @@ evas_object_precise_is_inside_get(const Evas_Object *obj)
MAGIC_CHECK_END();
return obj->precise_is_inside;
}
/**
* @}
*/

2
legacy/evas/src/lib/canvas/evas_object_polygon.c
View File

@ -74,7 +74,7 @@ static const Evas_Object_Func object_func =
/**
* @addtogroup Evas_Object_Polygon
* @{
* @ingroup Evas_Object_Group
* @ingroup Evas_Object_Specific
*/
/**

2
legacy/evas/src/lib/canvas/evas_object_rectangle.c
View File

@ -71,7 +71,7 @@ static const Evas_Object_Func object_func =
/**
* @addtogroup Evas_Object_Rectangle
* @{
* @ingroup Evas_Object_Group
* @ingroup Evas_Object_Specific
*/
/**

4
legacy/evas/src/lib/canvas/evas_object_text.c
View File

@ -84,7 +84,7 @@ static const Evas_Object_Func object_func =
/**
* @addtogroup Evas_Object_Text
* @{
* @ingroup Evas_Object_Group
* @ingroup Evas_Object_Specific
*/
/**
@ -957,7 +957,7 @@ evas_object_text_style_pad_get(const Evas_Object *obj, int *l, int *r, int *t, i
*/
/**
* @defgroup Evas_Font_Path_Group Font Path Functions
* @defgroup Evas_Font_Path_Group Evas Font Path Functions
*
* Functions that edit the paths being used to load fonts.
*/

2
legacy/evas/src/lib/canvas/evas_object_textblock.c
View File

@ -208,7 +208,7 @@ static const Evas_Object_Func object_func =
/**
* @addtogroup Evas_Object_Textblock
* @{
* @ingroup Evas_Object_Group
* @ingroup Evas_Object_Specific
*/
/* styles */

9
legacy/evas/src/lib/canvas/evas_smart.c
View File

@ -10,6 +10,11 @@
*
*/
/**
* @addtogroup Evas_Smart_Group
* @{
*/
/**
* Create an Evas_Smart, which can be used to instantiate new smart objects.
*
@ -175,6 +180,10 @@ evas_smart_data_get(const Evas_Smart *s)
return (void *)s->smart_class->data;
}
/**
* @}
*/
/* internal funcs */
void
evas_object_smart_use(Evas_Smart *s)