From: Myoungwoon Roy, Kim Date: Wed, 6 Jan 2021 09:21:12 +0000 (+0900) Subject: docs: Fix errors in Evas that make wrong API reference documentation X-Git-Tag: accepted/tizen/unified/20210112.123544^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F85%2F250985%2F1;p=platform%2Fupstream%2Fefl.git docs: Fix errors in Evas that make wrong API reference documentation Change-Id: I1be1d3f31114b9972f132bcd1df06ea1c841af07 --- diff --git a/src/lib/evas/Evas_Common.h b/src/lib/evas/Evas_Common.h index 8888e64..4ecd9fd 100644 --- a/src/lib/evas/Evas_Common.h +++ b/src/lib/evas/Evas_Common.h @@ -2601,7 +2601,7 @@ struct _Evas_Object_Smart_Clipped_Data }; /** - * Set a given smart class' callbacks so it implements the clipped smart + * Set a given smart class' callbacks so it implements the "clipped smart * object"'s interface. * * @param sc The smart class handle to operate on @@ -2960,8 +2960,12 @@ typedef struct _Evas_Cserve_Image Evas_Cserve_Image; typedef struct _Evas_Cserve_Config Evas_Cserve_Config; /** + * @addtogroup Evas_Cserve + * + * @{ + */ +/** * Statistics about the server that shares cached bitmaps. - * @ingroup Evas_Cserve */ struct _Evas_Cserve_Stats { @@ -2975,7 +2979,6 @@ struct _Evas_Cserve_Stats /** * A handle of a cache of images shared by a server. - * @ingroup Evas_Cserve */ struct _Evas_Cserve_Image_Cache { @@ -2989,7 +2992,6 @@ struct _Evas_Cserve_Image_Cache /** * A handle to an image shared by a server. - * @ingroup Evas_Cserve */ struct _Evas_Cserve_Image { @@ -3012,7 +3014,6 @@ struct _Evas_Cserve_Image /** * Configuration that controls the server that shares cached bitmaps. - * @ingroup Evas_Cserve */ struct _Evas_Cserve_Config { @@ -3024,7 +3025,6 @@ struct _Evas_Cserve_Config /** * Retrieves if the system wants to share bitmaps using the server. * @return @c EINA_TRUE if it wants, @c EINA_FALSE otherwise. - * @ingroup Evas_Cserve */ EAPI Eina_Bool evas_cserve_want_get(void) EINA_WARN_UNUSED_RESULT; @@ -3033,7 +3033,6 @@ EAPI Eina_Bool evas_cserve_want_get(void) EINA_WARN_UNUSED_RESULT; * bitmaps. * * @return @c EINA_TRUE if it's connected, @c EINA_FALSE otherwise. - * @ingroup Evas_Cserve */ EAPI Eina_Bool evas_cserve_connected_get(void) EINA_WARN_UNUSED_RESULT; @@ -3044,7 +3043,6 @@ EAPI Eina_Bool evas_cserve_connected_get(void) EINA_WARN_UNUSED_RESULT; * * @return @c EINA_TRUE if @p stats were filled with data, * @c EINA_FALSE otherwise (when @p stats is untouched) - * @ingroup Evas_Cserve */ EAPI Eina_Bool evas_cserve_stats_get(Evas_Cserve_Stats *stats) EINA_WARN_UNUSED_RESULT; @@ -3072,7 +3070,6 @@ EAPI void evas_cserve_image_cache_contents_clean(Evas_Cserve_Image_Cache * * @see evas_cserve_config_set() * - * @ingroup Evas_Cserve */ EAPI Eina_Bool evas_cserve_config_get(Evas_Cserve_Config *config) EINA_WARN_UNUSED_RESULT; @@ -3088,16 +3085,17 @@ EAPI Eina_Bool evas_cserve_config_get(Evas_Cserve_Config *config) EINA_WARN_UN * * @see evas_cserve_config_get() * - * @ingroup Evas_Cserve */ EAPI Eina_Bool evas_cserve_config_set(const Evas_Cserve_Config *config) EINA_WARN_UNUSED_RESULT; /** * Force the system to disconnect from the bitmap caching server. * - * @ingroup Evas_Cserve */ EAPI void evas_cserve_disconnect(void); +/** + * @} + */ /** * @defgroup Evas_Utils General Utilities @@ -3108,6 +3106,11 @@ EAPI void evas_cserve_disconnect(void); */ /** + * @addtogroup Evas_Utils + * + * @{ + */ +/** * Converts the given Evas image load error code into a string * describing it in human-readable text. * @@ -3134,7 +3137,6 @@ EAPI void evas_cserve_disconnect(void); * not exist", respectively. See the full @ref * Example_Evas_Images "example". * - * @ingroup Evas_Utils */ EAPI const char *evas_load_error_str(Evas_Load_Error error); @@ -3155,7 +3157,6 @@ EAPI const char *evas_load_error_str(Evas_Load_Error error); * This function converts a given color in HSV color format to RGB * color format. * - * @ingroup Evas_Utils **/ EAPI void evas_color_hsv_to_rgb(float h, float s, float v, int *r, int *g, int *b); @@ -3172,7 +3173,6 @@ EAPI void evas_color_hsv_to_rgb(float h, float s, float v, int *r, int *g, int * * This function converts a given color in RGB color format to HSV * color format. * - * @ingroup Evas_Utils **/ EAPI void evas_color_rgb_to_hsv(int r, int g, int b, float *h, float *s, float *v); @@ -3189,7 +3189,6 @@ EAPI void evas_color_rgb_to_hsv(int r, int g, int b, float *h, float *s, float * * This function pre-multiplies a given rgb triplet by an alpha * factor. Alpha factor is used to define transparency. * - * @ingroup Evas_Utils **/ EAPI void evas_color_argb_premul(int a, int *r, int *g, int *b); @@ -3206,7 +3205,6 @@ EAPI void evas_color_argb_premul(int a, int *r, int *g, int *b); * * @see evas_color_argb_premul(). * - * @ingroup Evas_Utils **/ EAPI void evas_color_argb_unpremul(int a, int *r, int *g, int *b); @@ -3219,7 +3217,6 @@ EAPI void evas_color_argb_unpremul(int a, int *r, int *g, int *b); * This function pre-multiplies a given data by an alpha * factor. Alpha factor is used to define transparency. * - * @ingroup Evas_Utils **/ EAPI void evas_data_argb_premul(unsigned int *data, unsigned int len); @@ -3232,7 +3229,6 @@ EAPI void evas_data_argb_premul(unsigned int *data, unsigned int len); * This function undoes pre-multiplication of a given data by an alpha * factor. Alpha factor is used to define transparency. * - * @ingroup Evas_Utils **/ EAPI void evas_data_argb_unpremul(unsigned int *data, unsigned int len); @@ -3255,7 +3251,6 @@ EAPI void evas_data_argb_unpremul(unsigned int *data, unsigned int len); * * @return The byte index of the next character * - * @ingroup Evas_Utils */ EAPI int evas_string_char_next_get(const char *str, int pos, int *decoded) EINA_ARG_NONNULL(1); @@ -3276,7 +3271,6 @@ EAPI int evas_string_char_next_get(const char *str, int pos, int *decoded) EINA * * @return The byte index of the previous character * - * @ingroup Evas_Utils */ EAPI int evas_string_char_prev_get(const char *str, int pos, int *decoded) EINA_ARG_NONNULL(1); @@ -3286,14 +3280,12 @@ EAPI int evas_string_char_prev_get(const char *str, int pos, int *decoded) EINA * @param str The string to get the length of. * @return The length in characters (not bytes) * - * @ingroup Evas_Utils */ EAPI int evas_string_char_len_get(const char *str) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); /** * Get language direction. * - * @ingroup Evas_Utils * @since 1.20 */ EAPI Evas_BiDi_Direction evas_language_direction_get(void); @@ -3304,10 +3296,12 @@ EAPI Evas_BiDi_Direction evas_language_direction_get(void); * The locale can change while a process is running. This call tells evas to * reload the locale from the environment like it does on start. * - * @ingroup Evas_Utils * @since 1.18 */ EAPI void evas_language_reinit(void); +/** + * @} + */ /** * @defgroup Evas_Keys Key Input Functions diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h index 93d9737..2e79f8e 100755 --- a/src/lib/evas/Evas_Legacy.h +++ b/src/lib/evas/Evas_Legacy.h @@ -1261,7 +1261,7 @@ EAPI Eina_Bool evas_font_hinting_can_hint(const Evas *e, Evas_Font_Hinting_Flags */ /** - * @ingroup Evas_Object_Group_Basic + * @addtogroup Evas_Object_Group_Basic * * @{ */ @@ -1301,7 +1301,6 @@ EAPI Eina_Bool evas_font_hinting_can_hint(const Evas *e, Evas_Font_Hinting_Flags * evas_object_unref(obj); * @endcode * - * @ingroup Evas_Object_Group_Basic * @since 1.1 */ EAPI void evas_object_ref(Evas_Object *obj); @@ -1319,7 +1318,6 @@ EAPI void evas_object_ref(Evas_Object *obj); * @see evas_object_ref() (for an example) * @see evas_object_del() * - * @ingroup Evas_Object_Group_Basic * @since 1.1 */ EAPI void evas_object_unref(Evas_Object *obj); @@ -1338,7 +1336,6 @@ EAPI void evas_object_unref(Evas_Object *obj); * @see evas_object_unref() * @see evas_object_del() * - * @ingroup Evas_Object_Group_Basic * @since 1.2 */ EAPI int evas_object_ref_get(const Evas_Object *obj); @@ -1361,7 +1358,6 @@ EAPI int evas_object_ref_get(const Evas_Object *obj); * @see evas_object_ref() * @see evas_object_unref() * - * @ingroup Evas_Object_Group_Basic */ EAPI void evas_object_del(Evas_Object *obj) EINA_ARG_NONNULL(1); @@ -1374,12 +1370,11 @@ EAPI void evas_object_del(Evas_Object *obj) EINA_ARG_NONNULL(1); * For Evas smart objects (see @ref Evas_Smart_Group), the name of the smart * class itself is returned on this call. For the built-in smart objects, these * names are "EvasObjectSmartClipped" for the clipped smart object, - * "Evas_Object_Box" for the box object and "Evas_Object_Table for the table + * "Evas_Object_Box" for the box object and "Evas_Object_Table" for the table * object. * * @return The type of the object. * - * @ingroup Evas_Object_Group_Basic * @since 1.18 */ EAPI const char *evas_object_type_get(const Evas_Object *obj); @@ -1391,7 +1386,6 @@ EAPI const char *evas_object_type_get(const Evas_Object *obj); * * @param[in] name The given name. * - * @ingroup Evas_Object_Group_Basic */ EAPI void evas_object_name_set(Evas_Object *obj, const char *name); @@ -1402,7 +1396,6 @@ EAPI void evas_object_name_set(Evas_Object *obj, const char *name); * * @return The given name. * - * @ingroup Evas_Object_Group_Basic */ EAPI const char *evas_object_name_get(const Evas_Object *obj); @@ -1426,7 +1419,6 @@ EAPI const char *evas_object_name_get(const Evas_Object *obj); * * @since 1.2 * - * @ingroup Evas_Object_Group_Basic */ EAPI Evas_Object *evas_object_name_child_find(const Evas_Object *obj, const char *name, int recurse) EINA_WARN_UNUSED_RESULT; @@ -1457,7 +1449,6 @@ EAPI Evas_Object *evas_object_name_child_find(const Evas_Object *obj, const char * * See the full @ref Example_Evas_Events "example". * - * @ingroup Evas_Object_Group_Basic */ EAPI void evas_object_geometry_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1); @@ -1484,7 +1475,6 @@ EAPI void evas_object_geometry_get(const Evas_Object *obj, Evas_Coor * @see evas_object_geometry_get * * @since 1.8 - * @ingroup Evas_Object_Group_Basic */ EAPI void evas_object_geometry_set(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1); @@ -1500,7 +1490,6 @@ EAPI void evas_object_geometry_set(Evas_Object *obj, Evas_Coord x, E * @see evas_object_hide() for more on object visibility. * @see evas_object_visible_get() * - * @ingroup Evas_Object_Group_Basic */ EAPI void evas_object_show(Evas_Object *obj) EINA_ARG_NONNULL(1); @@ -1532,7 +1521,6 @@ EAPI void evas_object_show(Evas_Object *obj) EINA_ARG_NONNULL(1); * * See the full @ref Example_Evas_Object_Manipulation "example". * - * @ingroup Evas_Object_Group_Basic */ EAPI void evas_object_hide(Evas_Object *obj) EINA_ARG_NONNULL(1); @@ -1544,7 +1532,6 @@ EAPI void evas_object_hide(Evas_Object *obj) EINA_ARG_NONNULL(1); * @see evas_object_color_get() (for an example) * @note These color values are expected to be premultiplied by @p a. * - * @ingroup Evas_Object_Group_Basic * * @param[in] r The red component of the given color. * @param[in] g The green component of the given color. @@ -1581,7 +1568,6 @@ EAPI void evas_object_color_set(Evas_Object *obj, int r, int g, int b, int a); * * See the full @ref Example_Evas_Object_Manipulation "example". * - * @ingroup Evas_Object_Group_Basic * * @param[out] r The red component of the given color. * @param[out] g The green component of the given color.