From: Marcel Hollerbach <mail@marcel-hollerbach.de>
Date: Thu, 21 Feb 2019 14:56:16 +0000 (+0100)
Subject: efl_loop_timer: resolve fixups of documentation
X-Git-Tag: submit/tizen/20190308.115227~154
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=c6ddfba8e9a8a2a6856ffd948132dd11686553ae;p=platform%2Fupstream%2Fefl.git

efl_loop_timer: resolve fixups of documentation

this resolves a few FIXMEs regarding documentation.
Overwriting functions does not help that much, since the documentation
will not be displayed in a IDE, so the documentation of these functions
are moved to the class documentation, which is assosiated with the
object.

Reviewed-by: Cedric BAIL <cedric.bail@free.fr>
Reviewed-by: Xavi Artigas <xavierartigas@yahoo.es>
Differential Revision: https://phab.enlightenment.org/D7983
---

diff --git a/src/lib/ecore/efl_loop_timer.eo b/src/lib/ecore/efl_loop_timer.eo
index b8c09be..287da12 100644
--- a/src/lib/ecore/efl_loop_timer.eo
+++ b/src/lib/ecore/efl_loop_timer.eo
@@ -6,6 +6,8 @@ class @beta Efl.Loop_Timer extends Efl.Loop_Consumer
      Timers require the ecore main loop to be running and functioning
      properly. They do not guarantee exact timing but try to work on a
      "best effort" basis.
+
+     The @Efl.Object.event_freeze and @Efl.Object.event_thaw calls are used to pause and unpause the timer.
    ]]
    legacy_prefix: ecore_timer;
    methods {
@@ -30,15 +32,11 @@ class @beta Efl.Loop_Timer extends Efl.Loop_Consumer
          }
       }
       reset {
-         /* FIXME-doc:
-          * @note This is equivalent to (but faster than)
-          * @code
-          * ecore_timer_delay(timer, ecore_timer_interval_get(timer) - ecore_timer_pending_get(timer));
-          * @endcode
-          */
           [[Resets a timer to its full interval. This effectively makes the
             timer start ticking off from zero now.
 
+            This is equal to delaying the timer by the already passed time, since the timer started ticking
+
             @since 1.2
           ]]
       }
@@ -68,34 +66,7 @@ class @beta Efl.Loop_Timer extends Efl.Loop_Consumer
       Efl.Object.finalize;
       Efl.Object.event_freeze;
       Efl.Object.parent { set; }
-      /* XXX: can't document overridden methods
-       * Pauses a running timer.
-       *
-       * @param timer The timer to be paused.
-       *
-       * The timer callback won't be called while the timer is paused. The remaining
-       * time until the timer expires will be saved so the timer can be resumed with
-       * that same remaining time to expire, instead of expiring instantly. Use
-       * ecore_timer_thaw() to resume.
-       *
-       * @note Nothing happens if the timer was already paused.
-       *
-       * @see ecore_timer_thaw()
-       */
       Efl.Object.event_freeze_count { get; }
       Efl.Object.event_thaw;
-      /* XXX: can't document overridden methods
-       * Resumes a frozen (paused) timer.
-       *
-       * @param timer The timer to be resumed.
-       *
-       * The timer will be resumed from its previous relative position. This
-       * means if it had X seconds remaining until expiry when paused, it will
-       * now start with those same X seconds remaining.
-       * The interval time won't be affected by this call nor by
-       * ecore_timer_freeze().
-       *
-       * @see ecore_timer_freeze()
-       */
    }
 }