Elm animator: Apparently this is deprecated, update docs accordingly.

Hermet told me this is depercated and Transit should be used instead.
Anyhow, the functions were only marked as deprecated with the warning macro
and not in docs, fixed that.

git-svn-id: https://svn.enlightenment.org/svn/e/trunk/elementary@61082 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

diff --git a/src/lib/Elementary.h.in b/src/lib/Elementary.h.in
index eeacb88..0a8dfb2 100644 (file)
--- a/src/lib/Elementary.h.in
+++ b/src/lib/Elementary.h.in
@@ -5203,6 +5203,7 @@ extern "C" {
     * The @a parent argument can be set to NULL for no parent. If a parent is set
     * there is no need to call elm_animator_del(), when the parent is deleted it
     * will delete the animator.
+    * @deprecated Use @ref Transit instead.
     */
    EINA_DEPRECATED EAPI Elm_Animator*            elm_animator_add(Evas_Object *parent);
    /**
@@ -5211,6 +5212,7 @@ extern "C" {
     * automatically called when the parent is deleted.
     *
     * @param[in] animator Animator object
+    * @deprecated Use @ref Transit instead.
     */
    EINA_DEPRECATED EAPI void                     elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
    /**
@@ -5218,6 +5220,7 @@ extern "C" {
     *
     * @param[in] animator Animator object
     * @param[in] duration Duration in second
+    * @deprecated Use @ref Transit instead.
     */
    EINA_DEPRECATED EAPI void                     elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
    /**
@@ -5230,6 +5233,7 @@ extern "C" {
     * The @p func callback will be called with a frame value in range [0, 1] which
     * indicates how far along the animation should be. It is the job of @p func to
     * actually change the state of any object(or objects) that are being animated.
+    * @deprecated Use @ref Transit instead.
     */
    EINA_DEPRECATED EAPI void                     elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
    /**
@@ -5240,6 +5244,7 @@ extern "C" {
     * @param[in]  data Callback function user argument
     *
     * @warning @a func will not be executed if elm_animator_stop() is called.
+    * @deprecated Use @ref Transit instead.
     */
    EINA_DEPRECATED EAPI void                     elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
    /**
@@ -5251,6 +5256,7 @@ extern "C" {
     * animation in progress the animation will be stopped(the operation callback
     * will not be executed again) and it can't be restarted using
     * elm_animator_resume().
+    * @deprecated Use @ref Transit instead.
     */
    EINA_DEPRECATED EAPI void                     elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
    /**
@@ -5258,6 +5264,7 @@ extern "C" {
     *
     * @param[in]  animator Animator object
     * @param[in]  repeat_cnt Repeat count
+    * @deprecated Use @ref Transit instead.
     */
    EINA_DEPRECATED EAPI void                     elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
    /**
@@ -5268,6 +5275,7 @@ extern "C" {
     * This function starts the animation if the nescessary properties(duration
     * and operation callback) have been set. Once started the animation will
     * run until complete or elm_animator_stop() is called.
+    * @deprecated Use @ref Transit instead.
     */
    EINA_DEPRECATED EAPI void                     elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
    /**
@@ -5275,6 +5283,7 @@ extern "C" {
     *
     * @param[in] animator Animator object
     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
+    * @deprecated Use @ref Transit instead.
     */
    EINA_DEPRECATED EAPI void                     elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
    /**
@@ -5282,6 +5291,7 @@ extern "C" {
     *
     * @param[in] animator Animator object
     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
+    * @deprecated Use @ref Transit instead.
     */
    EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator); EINA_ARG_NONNULL(1);
    /**
@@ -5295,12 +5305,14 @@ extern "C" {
     * will run in reverse once for each time it ran forward.@n
     * Runnin an animation in reverse is accomplished by calling the operation
     * callback with a frame value starting at 1 and diminshing until 0.
+    * @deprecated Use @ref Transit instead.
     */
    EINA_DEPRECATED EAPI void                     elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
    /**
     * Gets wether the animation will automatically reversed
     *
     * @param[in] animator Animator object
+    * @deprecated Use @ref Transit instead.
     */
    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
    /**
@@ -5310,12 +5322,14 @@ extern "C" {
     * or through elm_animator_stop()).
     *
     * @param[in] animator Animator object
+    * @deprecated Use @ref Transit instead.
     */
    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
    /**
     * Gets how many times the animation will be repeated
     *
     * @param[in] animator Animator object
+    * @deprecated Use @ref Transit instead.
     */
    EINA_DEPRECATED EAPI unsigned int             elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
    /**
@@ -5327,6 +5341,7 @@ extern "C" {
     * will not be called). If the animation is not yet running this is a no-op.
     * Once an animation has been paused with this function it can be resumed
     * using elm_animator_resume().
+    * @deprecated Use @ref Transit instead.
     */
    EINA_DEPRECATED EAPI void                     elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
    /**
@@ -5344,6 +5359,7 @@ extern "C" {
     * animation with a duration of 3 seconds is paused after 1 second for 1 second
     * it will resume as if it had ben animating for 2 seconds, the operating
     * callback will be called with a frame value of aproximately 2/3.
+    * @deprecated Use @ref Transit instead.
     */
    EINA_DEPRECATED EAPI void                     elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
    /**