summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2020-05-08 12:30:13 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2020-05-08 12:32:09 +0200
commit19da175f946dc398caf38e013474b1817fc8c23b (patch)
treea6aac7d83dca075a73bcbaf4a13bb6cefde2fb60
parent998dd2f61621fe54da8307ae7e0c1acc90c4879c (diff)
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
-rw-r--r--src/lib/evas/Evas_Legacy.h12
-rw-r--r--src/lib/evas/canvas/evas_canvas_eo.h6
-rw-r--r--src/lib/evas/canvas/evas_canvas_eo.legacy.h11
3 files changed, 16 insertions, 13 deletions
diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h
index e41edfaad5..cb13afdd0f 100644
--- a/src/lib/evas/Evas_Legacy.h
+++ b/src/lib/evas/Evas_Legacy.h
@@ -1923,11 +1923,11 @@ EAPI void evas_object_size_hint_display_mode_set(Evas_Object *obj, Evas_Display_
1923 * 1923 *
1924 * These are hints on the display mode @c obj. This is not a size enforcement 1924 * These are hints on the display mode @c obj. This is not a size enforcement
1925 * in any way, it's just a hint that can be used whenever appropriate. This 1925 * in any way, it's just a hint that can be used whenever appropriate. This
1926 * mode can be used object's display mode like commpress or expand. 1926 * mode can be used object's display mode like compress or expand.
1927 * 1927 *
1928 * @return Display mode hint. 1928 * @return Display mode hint.
1929 * 1929 *
1930 * @ingroup Evas_Objects 1930 * @ingroup Evas_Object_Group
1931 */ 1931 */
1932EAPI Evas_Display_Mode evas_object_size_hint_display_mode_get(const Evas_Object *obj); 1932EAPI Evas_Display_Mode evas_object_size_hint_display_mode_get(const Evas_Object *obj);
1933 1933
@@ -1952,6 +1952,7 @@ EAPI Evas_Display_Mode evas_object_size_hint_display_mode_get(const Evas_Object
1952 * 1952 *
1953 * @param[in] l The number of the layer to place the object on. 1953 * @param[in] l The number of the layer to place the object on.
1954Must be between #EVAS_LAYER_MIN and #EVAS_LAYER_MAX. 1954Must be between #EVAS_LAYER_MIN and #EVAS_LAYER_MAX.
1955 * @ingroup Evas_Object_Group
1955 */ 1956 */
1956EAPI void evas_object_layer_set(Evas_Object *obj, short l); 1957EAPI void evas_object_layer_set(Evas_Object *obj, short l);
1957 1958
@@ -1963,6 +1964,7 @@ EAPI void evas_object_layer_set(Evas_Object *obj, short l);
1963 * 1964 *
1964 * @see evas_object_layer_set() 1965 * @see evas_object_layer_set()
1965 * 1966 *
1967 * @ingroup Evas_Object_Group
1966 */ 1968 */
1967EAPI short evas_object_layer_get(const Evas_Object *obj); 1969EAPI short evas_object_layer_get(const Evas_Object *obj);
1968 1970
@@ -1980,6 +1982,7 @@ EAPI short evas_object_layer_get(const Evas_Object *obj);
1980 * @see evas_object_layer_set() 1982 * @see evas_object_layer_set()
1981 * @see evas_object_below_get() 1983 * @see evas_object_below_get()
1982 * 1984 *
1985 * @ingroup Evas_Object_Group
1983 */ 1986 */
1984EAPI Evas_Object *evas_object_below_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT; 1987EAPI Evas_Object *evas_object_below_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT;
1985 1988
@@ -1997,6 +2000,7 @@ EAPI Evas_Object *evas_object_below_get(const Evas_Object *obj) EINA_WARN_UNUSED
1997 * @see evas_object_layer_set() 2000 * @see evas_object_layer_set()
1998 * @see evas_object_below_get() 2001 * @see evas_object_below_get()
1999 * 2002 *
2003 * @ingroup Evas_Object_Group
2000 */ 2004 */
2001EAPI Evas_Object *evas_object_above_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT; 2005EAPI Evas_Object *evas_object_above_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT;
2002 2006
@@ -2026,6 +2030,7 @@ EAPI Evas_Object *evas_object_above_get(const Evas_Object *obj) EINA_WARN_UNUSED
2026 * 2030 *
2027 * 2031 *
2028 * @param[in] below the object below which to stack 2032 * @param[in] below the object below which to stack
2033 * @ingroup Evas_Object_Group
2029 */ 2034 */
2030EAPI void evas_object_stack_below(Evas_Object *obj, Evas_Object *below) EINA_ARG_NONNULL(2); 2035EAPI void evas_object_stack_below(Evas_Object *obj, Evas_Object *below) EINA_ARG_NONNULL(2);
2031 2036
@@ -2040,6 +2045,7 @@ EAPI void evas_object_stack_below(Evas_Object *obj, Evas_Object *below) EINA_ARG
2040 * @see evas_object_stack_below() 2045 * @see evas_object_stack_below()
2041 * @see evas_object_lower() 2046 * @see evas_object_lower()
2042 * 2047 *
2048 * @ingroup Evas_Object_Group
2043 * 2049 *
2044 */ 2050 */
2045EAPI void evas_object_raise(Evas_Object *obj); 2051EAPI void evas_object_raise(Evas_Object *obj);
@@ -2070,6 +2076,7 @@ EAPI void evas_object_raise(Evas_Object *obj);
2070 * 2076 *
2071 * 2077 *
2072 * @param[in] above the object above which to stack 2078 * @param[in] above the object above which to stack
2079 * @ingroup Evas_Object_Group
2073 */ 2080 */
2074EAPI void evas_object_stack_above(Evas_Object *obj, Evas_Object *above) EINA_ARG_NONNULL(2); 2081EAPI void evas_object_stack_above(Evas_Object *obj, Evas_Object *above) EINA_ARG_NONNULL(2);
2075 2082
@@ -2084,6 +2091,7 @@ EAPI void evas_object_stack_above(Evas_Object *obj, Evas_Object *above) EINA_ARG
2084 * @see evas_object_stack_below() 2091 * @see evas_object_stack_below()
2085 * @see evas_object_raise() 2092 * @see evas_object_raise()
2086 * 2093 *
2094 * @ingroup Evas_Object_Group
2087 * 2095 *
2088 */ 2096 */
2089EAPI void evas_object_lower(Evas_Object *obj); 2097EAPI void evas_object_lower(Evas_Object *obj);
diff --git a/src/lib/evas/canvas/evas_canvas_eo.h b/src/lib/evas/canvas/evas_canvas_eo.h
index 74cd5ef05c..370421449c 100644
--- a/src/lib/evas/canvas/evas_canvas_eo.h
+++ b/src/lib/evas/canvas/evas_canvas_eo.h
@@ -135,9 +135,7 @@ EOAPI void *evas_canvas_data_attach_get(const Eo *obj);
135 * 135 *
136 * See also @ref evas_object_focus_set, @ref evas_object_focus_get, @ref 136 * See also @ref evas_object_focus_set, @ref evas_object_focus_get, @ref
137 * evas_object_key_grab, @ref evas_object_key_ungrab, 137 * evas_object_key_grab, @ref evas_object_key_ungrab,
138 * @ref evas_canvas_seat_focus_get, @ref efl_canvas_object_seat_focus_check, 138 * @ref evas_canvas_seat_focus_get
139 * @ref efl_canvas_object_seat_focus_add,
140 * @ref efl_canvas_object_seat_focus_del.
141 * 139 *
142 * @param[in] obj The object. 140 * @param[in] obj The object.
143 * 141 *
@@ -325,7 +323,7 @@ EOAPI void evas_canvas_pointer_output_xy_get(const Eo *obj, int *x, int *y);
325 * only on the ones at the "top level", with regard to object parenting. 323 * only on the ones at the "top level", with regard to object parenting.
326 * 324 *
327 * See also @ref evas_object_layer_get, @ref evas_object_layer_set, @ref 325 * See also @ref evas_object_layer_get, @ref evas_object_layer_set, @ref
328 * evas_object_below_get, @ref evas_object_below_set. 326 * evas_object_below_get.
329 * 327 *
330 * @param[in] obj The object. 328 * @param[in] obj The object.
331 * 329 *
diff --git a/src/lib/evas/canvas/evas_canvas_eo.legacy.h b/src/lib/evas/canvas/evas_canvas_eo.legacy.h
index 3ef5d4c37d..af009aa6a6 100644
--- a/src/lib/evas/canvas/evas_canvas_eo.legacy.h
+++ b/src/lib/evas/canvas/evas_canvas_eo.legacy.h
@@ -127,10 +127,7 @@ EAPI void *evas_data_attach_get(const Evas_Canvas *obj);
127 * @c null, if none. 127 * @c null, if none.
128 * 128 *
129 * See also @ref evas_object_focus_set, @ref evas_object_focus_get, @ref 129 * See also @ref evas_object_focus_set, @ref evas_object_focus_get, @ref
130 * evas_object_key_grab, @ref evas_object_key_ungrab, @ref evas_seat_focus_get, 130 * evas_object_key_grab, @ref evas_object_key_ungrab, @ref evas_seat_focus_get.
131 * @ref Efl.Canvas.Object.seat_focus_check,
132 * @ref Efl.Canvas.Object.seat_focus_add,
133 * @ref Efl.Canvas.Object.seat_focus_del.
134 * 131 *
135 * @param[in] obj The object. 132 * @param[in] obj The object.
136 * 133 *
@@ -318,7 +315,7 @@ EAPI void evas_pointer_output_xy_get(const Evas_Canvas *obj, int *x, int *y);
318 * only on the ones at the "top level", with regard to object parenting. 315 * only on the ones at the "top level", with regard to object parenting.
319 * 316 *
320 * See also @ref evas_object_layer_get, @ref evas_object_layer_set, @ref 317 * See also @ref evas_object_layer_get, @ref evas_object_layer_set, @ref
321 * evas_object_below_get, @ref evas_object_below_set. 318 * evas_object_below_get.
322 * 319 *
323 * @param[in] obj The object. 320 * @param[in] obj The object.
324 * 321 *
@@ -540,7 +537,7 @@ EAPI void evas_norender(Evas_Canvas *obj);
540 * This function updates the canvas internal objects not triggering 537 * This function updates the canvas internal objects not triggering
541 * renderization. To force renderization function @ref evas_render should be 538 * renderization. To force renderization function @ref evas_render should be
542 * used. 539 * used.
543 * @param[in] obj The object. 540 * @param[in] eo_e The object.
544 * 541 *
545 * @since 1.24 542 * @since 1.24
546 * 543 *
@@ -800,7 +797,7 @@ EAPI int evas_coord_world_x_to_screen(const Evas_Canvas *obj, int x) EINA_WARN_U
800 * @param[in] obj The object. 797 * @param[in] obj The object.
801 * 798 *
802 * @return A newly allocated list of updated rectangles of the canvas 799 * @return A newly allocated list of updated rectangles of the canvas
803 * (@Eina.Rect structs). Free this list with @ref evas_render_updates_free. 800 * (@ref Eina_Rect structs). Free this list with @ref evas_render_updates_free.
804 * 801 *
805 * @ingroup Evas_Canvas 802 * @ingroup Evas_Canvas
806 */ 803 */