doxygen docs: Fix problems in Evas_Canvas

- Put some methods in a group so they are accessible and can be linked to.
- Remove references to Efl_ methods, unavailable in Legacy.
- Incorrect param names and typos
This commit is contained in:
Xavi Artigas 2020-05-08 12:30:13 +02:00
parent 998dd2f616
commit 19da175f94
3 changed files with 16 additions and 13 deletions

View File

@ -1923,11 +1923,11 @@ EAPI void evas_object_size_hint_display_mode_set(Evas_Object *obj, Evas_Display_
* *
* These are hints on the display mode @c obj. This is not a size enforcement * These are hints on the display mode @c obj. This is not a size enforcement
* in any way, it's just a hint that can be used whenever appropriate. This * in any way, it's just a hint that can be used whenever appropriate. This
* mode can be used object's display mode like commpress or expand. * mode can be used object's display mode like compress or expand.
* *
* @return Display mode hint. * @return Display mode hint.
* *
* @ingroup Evas_Objects * @ingroup Evas_Object_Group
*/ */
EAPI Evas_Display_Mode evas_object_size_hint_display_mode_get(const Evas_Object *obj); EAPI Evas_Display_Mode evas_object_size_hint_display_mode_get(const Evas_Object *obj);
@ -1952,6 +1952,7 @@ EAPI Evas_Display_Mode evas_object_size_hint_display_mode_get(const Evas_Object
* *
* @param[in] l The number of the layer to place the object on. * @param[in] l The number of the layer to place the object on.
Must be between #EVAS_LAYER_MIN and #EVAS_LAYER_MAX. Must be between #EVAS_LAYER_MIN and #EVAS_LAYER_MAX.
* @ingroup Evas_Object_Group
*/ */
EAPI void evas_object_layer_set(Evas_Object *obj, short l); EAPI void evas_object_layer_set(Evas_Object *obj, short l);
@ -1963,6 +1964,7 @@ EAPI void evas_object_layer_set(Evas_Object *obj, short l);
* *
* @see evas_object_layer_set() * @see evas_object_layer_set()
* *
* @ingroup Evas_Object_Group
*/ */
EAPI short evas_object_layer_get(const Evas_Object *obj); EAPI short evas_object_layer_get(const Evas_Object *obj);
@ -1980,6 +1982,7 @@ EAPI short evas_object_layer_get(const Evas_Object *obj);
* @see evas_object_layer_set() * @see evas_object_layer_set()
* @see evas_object_below_get() * @see evas_object_below_get()
* *
* @ingroup Evas_Object_Group
*/ */
EAPI Evas_Object *evas_object_below_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT; EAPI Evas_Object *evas_object_below_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT;
@ -1997,6 +2000,7 @@ EAPI Evas_Object *evas_object_below_get(const Evas_Object *obj) EINA_WARN_UNUSED
* @see evas_object_layer_set() * @see evas_object_layer_set()
* @see evas_object_below_get() * @see evas_object_below_get()
* *
* @ingroup Evas_Object_Group
*/ */
EAPI Evas_Object *evas_object_above_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT; EAPI Evas_Object *evas_object_above_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT;
@ -2026,6 +2030,7 @@ EAPI Evas_Object *evas_object_above_get(const Evas_Object *obj) EINA_WARN_UNUSED
* *
* *
* @param[in] below the object below which to stack * @param[in] below the object below which to stack
* @ingroup Evas_Object_Group
*/ */
EAPI void evas_object_stack_below(Evas_Object *obj, Evas_Object *below) EINA_ARG_NONNULL(2); EAPI void evas_object_stack_below(Evas_Object *obj, Evas_Object *below) EINA_ARG_NONNULL(2);
@ -2040,6 +2045,7 @@ EAPI void evas_object_stack_below(Evas_Object *obj, Evas_Object *below) EINA_ARG
* @see evas_object_stack_below() * @see evas_object_stack_below()
* @see evas_object_lower() * @see evas_object_lower()
* *
* @ingroup Evas_Object_Group
* *
*/ */
EAPI void evas_object_raise(Evas_Object *obj); EAPI void evas_object_raise(Evas_Object *obj);
@ -2070,6 +2076,7 @@ EAPI void evas_object_raise(Evas_Object *obj);
* *
* *
* @param[in] above the object above which to stack * @param[in] above the object above which to stack
* @ingroup Evas_Object_Group
*/ */
EAPI void evas_object_stack_above(Evas_Object *obj, Evas_Object *above) EINA_ARG_NONNULL(2); EAPI void evas_object_stack_above(Evas_Object *obj, Evas_Object *above) EINA_ARG_NONNULL(2);
@ -2084,6 +2091,7 @@ EAPI void evas_object_stack_above(Evas_Object *obj, Evas_Object *above) EINA_ARG
* @see evas_object_stack_below() * @see evas_object_stack_below()
* @see evas_object_raise() * @see evas_object_raise()
* *
* @ingroup Evas_Object_Group
* *
*/ */
EAPI void evas_object_lower(Evas_Object *obj); EAPI void evas_object_lower(Evas_Object *obj);

View File

@ -135,9 +135,7 @@ EOAPI void *evas_canvas_data_attach_get(const Eo *obj);
* *
* See also @ref evas_object_focus_set, @ref evas_object_focus_get, @ref * See also @ref evas_object_focus_set, @ref evas_object_focus_get, @ref
* evas_object_key_grab, @ref evas_object_key_ungrab, * evas_object_key_grab, @ref evas_object_key_ungrab,
* @ref evas_canvas_seat_focus_get, @ref efl_canvas_object_seat_focus_check, * @ref evas_canvas_seat_focus_get
* @ref efl_canvas_object_seat_focus_add,
* @ref efl_canvas_object_seat_focus_del.
* *
* @param[in] obj The object. * @param[in] obj The object.
* *
@ -325,7 +323,7 @@ EOAPI void evas_canvas_pointer_output_xy_get(const Eo *obj, int *x, int *y);
* only on the ones at the "top level", with regard to object parenting. * only on the ones at the "top level", with regard to object parenting.
* *
* See also @ref evas_object_layer_get, @ref evas_object_layer_set, @ref * See also @ref evas_object_layer_get, @ref evas_object_layer_set, @ref
* evas_object_below_get, @ref evas_object_below_set. * evas_object_below_get.
* *
* @param[in] obj The object. * @param[in] obj The object.
* *

View File

@ -127,10 +127,7 @@ EAPI void *evas_data_attach_get(const Evas_Canvas *obj);
* @c null, if none. * @c null, if none.
* *
* See also @ref evas_object_focus_set, @ref evas_object_focus_get, @ref * See also @ref evas_object_focus_set, @ref evas_object_focus_get, @ref
* evas_object_key_grab, @ref evas_object_key_ungrab, @ref evas_seat_focus_get, * evas_object_key_grab, @ref evas_object_key_ungrab, @ref evas_seat_focus_get.
* @ref Efl.Canvas.Object.seat_focus_check,
* @ref Efl.Canvas.Object.seat_focus_add,
* @ref Efl.Canvas.Object.seat_focus_del.
* *
* @param[in] obj The object. * @param[in] obj The object.
* *
@ -318,7 +315,7 @@ EAPI void evas_pointer_output_xy_get(const Evas_Canvas *obj, int *x, int *y);
* only on the ones at the "top level", with regard to object parenting. * only on the ones at the "top level", with regard to object parenting.
* *
* See also @ref evas_object_layer_get, @ref evas_object_layer_set, @ref * See also @ref evas_object_layer_get, @ref evas_object_layer_set, @ref
* evas_object_below_get, @ref evas_object_below_set. * evas_object_below_get.
* *
* @param[in] obj The object. * @param[in] obj The object.
* *
@ -540,7 +537,7 @@ EAPI void evas_norender(Evas_Canvas *obj);
* This function updates the canvas internal objects not triggering * This function updates the canvas internal objects not triggering
* renderization. To force renderization function @ref evas_render should be * renderization. To force renderization function @ref evas_render should be
* used. * used.
* @param[in] obj The object. * @param[in] eo_e The object.
* *
* @since 1.24 * @since 1.24
* *
@ -800,7 +797,7 @@ EAPI int evas_coord_world_x_to_screen(const Evas_Canvas *obj, int x) EINA_WARN_U
* @param[in] obj The object. * @param[in] obj The object.
* *
* @return A newly allocated list of updated rectangles of the canvas * @return A newly allocated list of updated rectangles of the canvas
* (@Eina.Rect structs). Free this list with @ref evas_render_updates_free. * (@ref Eina_Rect structs). Free this list with @ref evas_render_updates_free.
* *
* @ingroup Evas_Canvas * @ingroup Evas_Canvas
*/ */