ecore: Move documentation for ecore_timer_add at the correct place.
authorStefan Schmidt <s.schmidt@samsung.com>
Wed, 1 Apr 2015 08:23:00 +0000 (10:23 +0200)
committerStefan Schmidt <s.schmidt@samsung.com>
Wed, 1 Apr 2015 08:23:00 +0000 (10:23 +0200)
Many thanks to Vinicius dos Santos Oliveira for spotting this and
pointing it out on the mailing list.

src/lib/ecore/Ecore_Common.h
src/lib/ecore/Ecore_Legacy.h

index 6af6932..c6cc1e7 100644 (file)
@@ -3065,24 +3065,6 @@ EAPI double ecore_timer_precision_get(void);
  */
 EAPI void ecore_timer_precision_set(double precision);
 
-/**
- * Creates a timer to call the given function in the given period of time.
- * @param   in   The interval in seconds.
- * @param   func The given function.  If @p func returns 1, the timer is
- *               rescheduled for the next interval @p in.
- * @param   data Data to pass to @p func when it is called.
- * @return  A timer object on success.  @c NULL on failure.
- *
- * This function adds a timer and returns its handle on success and NULL on
- * failure. The function @p func will be called every @p in seconds. The
- * function will be passed the @p data pointer as its parameter.
- *
- * When the timer @p func is called, it must return a value of either 1
- * (or ECORE_CALLBACK_RENEW) or 0 (or ECORE_CALLBACK_CANCEL).
- * If it returns 1, it will be called again at the next tick, or if it returns
- * 0 it will be deleted automatically making any references/handles for it
- * invalid.
- */
 EAPI char *ecore_timer_dump(void);
 
 /**
index 90d801f..b457b97 100644 (file)
@@ -165,6 +165,24 @@ EAPI void ecore_animator_thaw(Ecore_Animator *animator);
  * @{
  */
 
+/**
+ * Creates a timer to call the given function in the given period of time.
+ * @param   in   The interval in seconds.
+ * @param   func The given function.  If @p func returns 1, the timer is
+ *               rescheduled for the next interval @p in.
+ * @param   data Data to pass to @p func when it is called.
+ * @return  A timer object on success.  @c NULL on failure.
+ *
+ * This function adds a timer and returns its handle on success and NULL on
+ * failure. The function @p func will be called every @p in seconds. The
+ * function will be passed the @p data pointer as its parameter.
+ *
+ * When the timer @p func is called, it must return a value of either 1
+ * (or ECORE_CALLBACK_RENEW) or 0 (or ECORE_CALLBACK_CANCEL).
+ * If it returns 1, it will be called again at the next tick, or if it returns
+ * 0 it will be deleted automatically making any references/handles for it
+ * invalid.
+ */
 EAPI Ecore_Timer *ecore_timer_add(double in, Ecore_Task_Cb func, const void *data);
 
 /**