doxygen docs: Fix most errors on Evas_Legacy.h

Oh boy... References to Unified API, horribly misshapen groups,
typos, invalid commands, invalid references, and on top of that,
Evas VG.
This commit is contained in:
Xavi Artigas 2020-04-27 17:25:27 +02:00
parent 0aa18d93ca
commit bc7608da73
3 changed files with 59 additions and 50 deletions

View File

@ -1261,9 +1261,10 @@ EAPI const Evas_Device *evas_device_emulation_source_get(const Evas_Device *dev)
*/ */
/** /**
* @defgroup Evas_Image_Group Image Functions * @defgroup Evas_Image Image Functions
* *
* Functions that deal with images at canvas level. * Functions that deal with images at canvas level. Compare with
* @ref Evas_Object_Image functions which deal with images at the object level.
* *
* @ingroup Evas_Canvas * @ingroup Evas_Canvas
*/ */

View File

@ -1562,6 +1562,7 @@ EAPI void evas_object_color_get(const Evas_Object *obj, int *r, int *g, int *b,
* *
* @param[in] x in * @param[in] x in
* @param[in] y in * @param[in] y in
* @ingroup Evas_Object_Group
*/ */
EAPI void evas_object_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y); EAPI void evas_object_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y);
@ -1571,6 +1572,7 @@ EAPI void evas_object_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y);
* *
* @param[in] w in * @param[in] w in
* @param[in] h in * @param[in] h in
* @ingroup Evas_Object_Group
*/ */
EAPI void evas_object_resize(Evas_Object *obj, Evas_Coord w, Evas_Coord h); EAPI void evas_object_resize(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
@ -1578,6 +1580,7 @@ EAPI void evas_object_resize(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
* *
* Retrieves whether or not the given Evas object is visible. * Retrieves whether or not the given Evas object is visible.
* *
* @ingroup Evas_Object_Group
*/ */
EAPI Eina_Bool evas_object_visible_get(const Evas_Object *obj); EAPI Eina_Bool evas_object_visible_get(const Evas_Object *obj);
@ -1753,7 +1756,7 @@ EAPI void evas_object_size_hint_padding_get(const Evas_Object *obj, Evas_Coord *
* weight macro) or the complete one of taking each child's weight hint as real * weight macro) or the complete one of taking each child's weight hint as real
* weights to how much of its size to allocate for them in each axis. A * weights to how much of its size to allocate for them in each axis. A
* container is supposed to, after normalizing the weights of its children * container is supposed to, after normalizing the weights of its children
* (with weight hints), distribut the space it has to layout them by those * (with weight hints), distribute the space it has to layout them by those
* factors -- most weighted children get larger in this process than the least * factors -- most weighted children get larger in this process than the least
* ones. * ones.
* *
@ -3526,7 +3529,7 @@ EAPI Evas_Object *evas_object_rectangle_add(Evas *e) EINA_WARN_UNUSED_RESULT EIN
* @defgroup Evas_Object_Vg Vector Graphics Object * @defgroup Evas_Object_Vg Vector Graphics Object
* @ingroup Evas * @ingroup Evas
* *
* Evas_Object_Vg is the scene graph for managing vector graphics objects. * @ref Evas_Object_Vg is the scene graph for managing vector graphics objects.
* User can create shape objects as well as fill objects and give them to the * User can create shape objects as well as fill objects and give them to the
* Evas_Object_Vg for drawing on the screen as well as managing the lifecycle * Evas_Object_Vg for drawing on the screen as well as managing the lifecycle
* of the objects, enabling reuse of shape objects. * of the objects, enabling reuse of shape objects.
@ -3586,6 +3589,8 @@ EAPI Evas_Object *evas_object_rectangle_add(Evas *e) EINA_WARN_UNUSED_RESULT EIN
* @endcode * @endcode
* *
* @since 1.14 * @since 1.14
*
* @{
*/ */
/** /**
@ -3691,8 +3696,6 @@ EAPI int evas_object_vg_animated_frame_get(const Evas_Object *obj) EINA_ARG_NONN
* stroke. @ref evas_vg_shape_stroke_cap_set * stroke. @ref evas_vg_shape_stroke_cap_set
* *
* @since 1.24 * @since 1.24
*
* @ingroup Evas_Vg_Cap
*/ */
typedef enum Evas_Vg_Cap_Type typedef enum Evas_Vg_Cap_Type
{ {
@ -3712,12 +3715,10 @@ typedef enum Evas_Vg_Cap_Type
* @ref evas_vg_shape_stroke_join_set * @ref evas_vg_shape_stroke_join_set
* *
* @since 1.24 * @since 1.24
*
* @ingroup Evas_Vg_Join
*/ */
typedef enum Evas_Vg_Join_Type typedef enum Evas_Vg_Join_Type
{ {
EVAS_VG_JOIN_MITER = 0, /**< Used to render mitered line joins. The intersectioni EVAS_VG_JOIN_MITER = 0, /**< Used to render mitered line joins. The intersection
* of the strokes is clipped at a line perpendicular to * of the strokes is clipped at a line perpendicular to
* the bisector of the angle between the strokes, at the * the bisector of the angle between the strokes, at the
* distance from the intersection of the segments equal * distance from the intersection of the segments equal
@ -3730,15 +3731,13 @@ typedef enum Evas_Vg_Join_Type
* triangular region of the corner with a straight line * triangular region of the corner with a straight line
* between the outer corners of each stroke */ * between the outer corners of each stroke */
EVAS_VG_JOIN_LAST /**< Sentinel value to indicate last enum field during EVAS_VG_JOIN_LAST /**< Sentinel value to indicate last enum field during
* teration */ * iteration */
} Evas_Vg_Join; } Evas_Vg_Join;
/** /**
* @brief These values determine how the points are interpreted in a stream of points. * @brief These values determine how the points are interpreted in a stream of points.
* *
* @since 1.24 * @since 1.24
*
* @ingroup Evas_Vg_Path_Command
*/ */
typedef enum Evas_Vg_Path_Command_Type typedef enum Evas_Vg_Path_Command_Type
{ {
@ -3760,8 +3759,6 @@ typedef enum Evas_Vg_Path_Command_Type
* transition point in a gradient. * transition point in a gradient.
* *
* @since 1.24 * @since 1.24
*
* @ingroup Evas_Vg_Gradient_Stop
*/ */
typedef struct _Evas_Vg_Gradient_Stop typedef struct _Evas_Vg_Gradient_Stop
{ {
@ -3778,8 +3775,6 @@ typedef struct _Evas_Vg_Gradient_Stop
* @ref evas_vg_gradient_spread_set * @ref evas_vg_gradient_spread_set
* *
* @since 1.24 * @since 1.24
*
* @ingroup Evas_Vg_Gradient_Spread
*/ */
typedef enum Evas_Vg_Gradient_Spread_Type typedef enum Evas_Vg_Gradient_Spread_Type
{ {
@ -3798,8 +3793,6 @@ typedef enum Evas_Vg_Gradient_Spread_Type
* @ref evas_vg_shape_stroke_dash_set * @ref evas_vg_shape_stroke_dash_set
* *
* @since 1.24 * @since 1.24
*
* @ingroup Evas_Vg_Dash
*/ */
typedef struct _Evas_Vg_Dash typedef struct _Evas_Vg_Dash
{ {
@ -3832,7 +3825,7 @@ EAPI Evas_Vg_Container* evas_vg_container_add(Evas_Object *parent);
* @brief Retrieves whether or not the given Evas_Vg_Node object is visible. * @brief Retrieves whether or not the given Evas_Vg_Node object is visible.
* *
* @param[in] obj The object. * @param[in] obj The object.
* @return @c EINA_TRUE if the object is visible, @EINA_FALSE otherwise. * @return @c EINA_TRUE if the object is visible, @c EINA_FALSE otherwise.
* *
* @since 1.24 * @since 1.24
*/ */
@ -3878,8 +3871,6 @@ EAPI void evas_vg_node_color_get(Evas_Vg_Node *obj, int *r, int *g, int *b, int
* @see evas_vg_node_color_get() (for an example) * @see evas_vg_node_color_get() (for an example)
* @note These color values are expected to be premultiplied by @p a. * @note These color values are expected to be premultiplied by @p a.
* *
* @ingroup Evas_Object_Group_Basic
*
* @param[in] obj The object. * @param[in] obj The object.
* @param[in] r The red component of the given color. * @param[in] r The red component of the given color.
* @param[in] g The green component of the given color. * @param[in] g The green component of the given color.
@ -4379,8 +4370,6 @@ EAPI void evas_vg_shape_append_arc_to(Evas_Vg_Shape *obj, double x, double y, do
* @param[in] sweep_length The length of the arc. * @param[in] sweep_length The length of the arc.
* *
* @since 1.18 * @since 1.18
*
* @ingroup Evas_Vg_Shape
*/ */
EAPI void evas_vg_shape_append_arc(Evas_Vg_Shape *obj, double x, double y, double w, double h, double start_angle, double sweep_length); EAPI void evas_vg_shape_append_arc(Evas_Vg_Shape *obj, double x, double y, double w, double h, double start_angle, double sweep_length);
@ -4479,7 +4468,7 @@ EAPI Eina_Bool evas_vg_shape_equal_commands(Evas_Vg_Shape *obj, const Eo *with);
* @brief Set a vg object as the fill property. * @brief Set a vg object as the fill property.
* *
* @param[in] obj The object whose fill property gets modified. * @param[in] obj The object whose fill property gets modified.
* @param[in] The object content will be used for filling. * @param[in] f The object content to be used for filling.
* *
* @since 1.24 * @since 1.24
*/ */
@ -4582,7 +4571,7 @@ EAPI Evas_Vg_Gradient_Linear* evas_vg_gradient_linear_add(Evas_Vg_Container *par
EAPI void evas_vg_gradient_linear_start_set(Evas_Vg_Gradient_Linear *obj, double x, double y); EAPI void evas_vg_gradient_linear_start_set(Evas_Vg_Gradient_Linear *obj, double x, double y);
/** /**
* @biref Gets the start point of this linear gradient. * @brief Gets the start point of this linear gradient.
* *
* @param[in] obj The object. * @param[in] obj The object.
* @param[out] x The x co-ordinate of start point. * @param[out] x The x co-ordinate of start point.
@ -5593,7 +5582,7 @@ EAPI void evas_object_image_filled_set(Evas_Object *obj, Eina_Bool filled);
* object's size. * object's size.
* *
* Returns @c true if it is tracking, @c false if not (and @ref * Returns @c true if it is tracking, @c false if not (and @ref
* evas_object_fill_set must be called manually). * evas_object_image_fill_set must be called manually).
* *
* @param[in] obj The object * @param[in] obj The object
* @return @c true to make the fill property follow object size or @c false * @return @c true to make the fill property follow object size or @c false
@ -5733,8 +5722,7 @@ typedef enum
* to be drawn, which must be one of the values in @ref Evas_Border_Fill_Mode. * to be drawn, which must be one of the values in @ref Evas_Border_Fill_Mode.
* By center we mean the complementary part of that defined by * By center we mean the complementary part of that defined by
* @ref evas_object_image_border_set. This one is very useful for making frames * @ref evas_object_image_border_set. This one is very useful for making frames
* and decorations. You would most probably also be using a filled image (as in * and decorations.
* @ref Efl.Gfx.Fill.fill_auto) to use as a frame.
* *
* @param[in] obj The object * @param[in] obj The object
* @param[in] fill Fill mode of the center region of @c obj (a value in * @param[in] fill Fill mode of the center region of @c obj (a value in
@ -5750,8 +5738,7 @@ EAPI void evas_object_image_border_center_fill_set(Evas_Object *obj, Evas_Border
* to be drawn, which must be one of the values in @ref Evas_Border_Fill_Mode. * to be drawn, which must be one of the values in @ref Evas_Border_Fill_Mode.
* By center we mean the complementary part of that defined by * By center we mean the complementary part of that defined by
* @ref evas_object_image_border_set. This one is very useful for making frames * @ref evas_object_image_border_set. This one is very useful for making frames
* and decorations. You would most probably also be using a filled image (as in * and decorations.
* @ref Efl.Gfx.Fill.fill_auto) to use as a frame.
* *
* The default value is * The default value is
* *
@ -5936,7 +5923,7 @@ EAPI void evas_object_image_data_copy_set(Evas_Object *obj, void *data);
* *
* Note that the raw data must be of the same size (see @ref * Note that the raw data must be of the same size (see @ref
* evas_object_image_size_set, which has to be called before this one) and * evas_object_image_size_set, which has to be called before this one) and
* colorspace (see @Evas.Image.colorspace.set) of the image. If data is * colorspace (see @ref evas_object_image_colorspace_set) of the image. If data is
* @c null, the current image data will be freed. Naturally, if one does not * @c null, the current image data will be freed. Naturally, if one does not
* set an image object's data manually, it will still have one, allocated by * set an image object's data manually, it will still have one, allocated by
* Evas. * Evas.
@ -5965,7 +5952,7 @@ EAPI void evas_object_image_data_set(Evas_Object *obj, void *data);
* @note The contents' format returned by it depend on the color space of the * @note The contents' format returned by it depend on the color space of the
* given image object. * given image object.
* *
* @note You may want to use @Evas.Image.data_update_add to inform data * @note You may want to use @ref evas_object_image_data_update_add to inform data
* changes, if you did any. * changes, if you did any.
* *
* @param[in] obj The object * @param[in] obj The object
@ -6844,10 +6831,6 @@ EAPI void *evas_object_smart_interface_data_get(const Evas_Object *o
* *
* If @c obj is not a smart object, this call will fail immediately. * If @c obj is not a smart object, this call will fail immediately.
* *
* This function supports Eo and legacy inheritance mechanisms. However, it is
* recommended to use @ref efl_isa instead if your object is using Eo from top
* to bottom.
*
* The checks use smart classes names and string comparison. There is a version * The checks use smart classes names and string comparison. There is a version
* of this same check using pointer comparison, since a smart class' name is a * of this same check using pointer comparison, since a smart class' name is a
* single string in Evas. * single string in Evas.
@ -6961,9 +6944,22 @@ EAPI Evas_Smart *evas_object_smart_smart_get(const Evas_Object *obj) EINA_WARN_U
* *
* See also @ref evas_object_smart_data_get. * See also @ref evas_object_smart_data_get.
* *
* @param[in] obj The object
* @param[in] data A pointer to user data. * @param[in] data A pointer to user data.
*/ */
EAPI void evas_object_smart_data_set(Evas_Object *obj, void *data); EAPI void evas_object_smart_data_set(Evas_Object *obj, void *data);
/**
* @brief Retrieves the pointer to user data for a given smart object.
*
* This data is stored independently of the one set by evas_object_data_set(),
* naturally.
*
* See also @ref evas_object_smart_data_set.
*
* @param[in] obj The object
* @return A pointer to user data.
*/
EAPI void *evas_object_smart_data_get(const Evas_Object *obj); EAPI void *evas_object_smart_data_get(const Evas_Object *obj);
/** /**
@ -6983,8 +6979,8 @@ EAPI Evas_Object *evas_object_smart_clipped_clipper_get(const Evas_Object *obj)
* *
* This function will return @c null when a non-smart object is passed. * This function will return @c null when a non-smart object is passed.
* *
* See also @ref Efl.Canvas.Group.group_member_add, * See also @ref evas_object_smart_member_add,
* @ref Efl.Canvas.Group.group_member_remove and @ref evas_object_smart_iterator_new. * @ref evas_object_smart_member_del and @ref evas_object_smart_iterator_new.
* *
* @return Returns the list of the member objects of @c obj. * @return Returns the list of the member objects of @c obj.
* *
@ -7034,8 +7030,8 @@ EAPI Eina_Bool evas_object_smart_need_recalculate_get(const Evas_Object *obj);
* @brief Retrieves an iterator of the member objects of a given Evas smart * @brief Retrieves an iterator of the member objects of a given Evas smart
* object. * object.
* *
* See also @ref Efl.Canvas.Group.group_member_add and * See also @ref evas_object_smart_member_add and
* @ref Efl.Canvas.Group.group_member_remove * @ref evas_object_smart_member_del
* *
* @return Returns the iterator of the member objects of @c obj. * @return Returns the iterator of the member objects of @c obj.
* *
@ -8321,7 +8317,7 @@ EAPI void evas_map_point_color_get(const Evas_Map *m, int idx, int *r
* *
* @param[in] map The map. * @param[in] map The map.
* *
* @ingroup Efl_Canvas_Object * @ingroup Evas_Object_Group
*/ */
EAPI void evas_object_map_set(Evas_Object *obj, const Evas_Map *map); EAPI void evas_object_map_set(Evas_Object *obj, const Evas_Map *map);
@ -8334,7 +8330,7 @@ EAPI void evas_object_map_set(Evas_Object *obj, const Evas_Map *map);
* *
* @return The map. * @return The map.
* *
* @ingroup Efl_Canvas_Object * @ingroup Evas_Object_Group
*/ */
EAPI const Evas_Map *evas_object_map_get(const Evas_Object *obj); EAPI const Evas_Map *evas_object_map_get(const Evas_Object *obj);

View File

@ -119,6 +119,11 @@ struct _Evas_Module
unsigned char loaded : 1; unsigned char loaded : 1;
}; };
/**
* @addtogroup Evas_Image
* @{
*/
typedef struct _Evas_Image_Load_Opts Evas_Image_Load_Opts; typedef struct _Evas_Image_Load_Opts Evas_Image_Load_Opts;
struct _Evas_Image_Load_Opts struct _Evas_Image_Load_Opts
@ -152,16 +157,19 @@ struct _Evas_Image_Property
typedef struct _Evas_Image_Load_Func Evas_Image_Load_Func; typedef struct _Evas_Image_Load_Func Evas_Image_Load_Func;
/**
* @brief Possible outcomes of a load operation
*/
typedef enum typedef enum
{ {
EVAS_LOAD_ERROR_NONE = 0, EVAS_LOAD_ERROR_NONE = 0, /**< No error on load */
EVAS_LOAD_ERROR_GENERIC, EVAS_LOAD_ERROR_GENERIC, /**< A non-specific error occurred */
EVAS_LOAD_ERROR_DOES_NOT_EXIST, EVAS_LOAD_ERROR_DOES_NOT_EXIST, /**< File (or file path) does not exist */
EVAS_LOAD_ERROR_PERMISSION_DENIED, EVAS_LOAD_ERROR_PERMISSION_DENIED, /**< Permission denied to an existing file (or path) */
EVAS_LOAD_ERROR_RESOURCE_ALLOCATION_FAILED, EVAS_LOAD_ERROR_RESOURCE_ALLOCATION_FAILED, /**< Allocation of resources failure prevented load */
EVAS_LOAD_ERROR_CORRUPT_FILE, EVAS_LOAD_ERROR_CORRUPT_FILE, /**< File corrupt (but was detected as a known format) */
EVAS_LOAD_ERROR_UNKNOWN_FORMAT, EVAS_LOAD_ERROR_UNKNOWN_FORMAT, /**< File is not a known format */
EVAS_LOAD_ERROR_CANCELLED, EVAS_LOAD_ERROR_CANCELLED, /**< File loading has been cancelled */
} Evas_Load_Error; } Evas_Load_Error;
typedef Emile_Image_Animated_Loop_Hint Evas_Image_Animated_Loop_Hint; typedef Emile_Image_Animated_Loop_Hint Evas_Image_Animated_Loop_Hint;
@ -290,6 +298,10 @@ evas_loader_helper_stretch_region_push(uint8_t **region,
return EINA_TRUE; return EINA_TRUE;
} }
/**
* @}
*/
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif