From 2d32c2a45c4263adfb9864fdf1b104881bd7c3bd Mon Sep 17 00:00:00 2001 From: Hermet Park Date: Thu, 16 Jan 2025 00:15:59 +0900 Subject: [PATCH] lottie: updated lottie apis doc - removed useless return value info. - removed all beta api tags. --- src/bindings/capi/thorvg_capi.h | 8 ++++---- src/loaders/lottie/thorvg_lottie.h | 12 ++++-------- 2 files changed, 8 insertions(+), 12 deletions(-) diff --git a/src/bindings/capi/thorvg_capi.h b/src/bindings/capi/thorvg_capi.h index 0ad11a03..d5deca67 100644 --- a/src/bindings/capi/thorvg_capi.h +++ b/src/bindings/capi/thorvg_capi.h @@ -2481,7 +2481,7 @@ TVG_API Tvg_Animation* tvg_lottie_animation_new(void); * @retval TVG_RESULT_INVALID_ARGUMENT When the given @p slot is invalid * @retval TVG_RESULT_NOT_SUPPORTED The Lottie Animation is not supported. * -* @note Experimental API +* @since 1.0 */ TVG_API Tvg_Result tvg_lottie_animation_override(Tvg_Animation* animation, const char* slot); @@ -2497,7 +2497,7 @@ TVG_API Tvg_Result tvg_lottie_animation_override(Tvg_Animation* animation, const * @retval TVG_RESULT_INVALID_ARGUMENT When the given @p marker is invalid. * @retval TVG_RESULT_NOT_SUPPORTED The Lottie Animation is not supported. * -* @note Experimental API +* @since 1.0 */ TVG_API Tvg_Result tvg_lottie_animation_set_marker(Tvg_Animation* animation, const char* marker); @@ -2511,7 +2511,7 @@ TVG_API Tvg_Result tvg_lottie_animation_set_marker(Tvg_Animation* animation, con * @return Tvg_Result enumeration. * @retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument. * -* @note Experimental API +* @since 1.0 */ TVG_API Tvg_Result tvg_lottie_animation_get_markers_cnt(Tvg_Animation* animation, uint32_t* cnt); @@ -2526,7 +2526,7 @@ TVG_API Tvg_Result tvg_lottie_animation_get_markers_cnt(Tvg_Animation* animation * @return Tvg_Result enumeration. * @retval TVG_RESULT_INVALID_ARGUMENT In case @c nullptr is passed as the argument or @c idx is out of range. * -* @note Experimental API +* @since 1.0 */ TVG_API Tvg_Result tvg_lottie_animation_get_marker(Tvg_Animation* animation, uint32_t idx, const char** name); diff --git a/src/loaders/lottie/thorvg_lottie.h b/src/loaders/lottie/thorvg_lottie.h index a199ec70..f2714a19 100644 --- a/src/loaders/lottie/thorvg_lottie.h +++ b/src/loaders/lottie/thorvg_lottie.h @@ -25,11 +25,9 @@ public: * * @param[in] slot The Lottie slot data in JSON format to override, or @c nullptr to reset. * - * @retval Result::Success When succeed. * @retval Result::InsufficientCondition In case the animation is not loaded. - * @retval Result::InvalidArguments When the given parameter is invalid. * - * @note Experimental API + * @since 1.0 */ Result override(const char* slot) noexcept; @@ -43,15 +41,13 @@ public: * * @param[in] marker The name of the segment marker. * - * @retval Result::Success When successful. * @retval Result::InsufficientCondition If the animation is not loaded. - * @retval Result::InvalidArguments When the given parameter is invalid. * @retval Result::NonSupport When it's not animatable. * * @note If a @c marker is specified, the previously set segment will be disregarded. * @note Set @c nullptr to reset the specified segment. * @see Animation::segment(float begin, float end) - * @note Experimental API + * @since 1.0 */ Result segment(const char* marker) noexcept; @@ -61,7 +57,7 @@ public: * @retval The count of the markers, zero if there is no marker. * * @see LottieAnimation::marker() - * @note Experimental API + * @since 1.0 */ uint32_t markersCnt() noexcept; @@ -73,7 +69,7 @@ public: * @retval The name of marker when succeed, @c nullptr otherwise. * * @see LottieAnimation::markersCnt() - * @note Experimental API + * @since 1.0 */ const char* marker(uint32_t idx) noexcept;