From: Jean-Philippe Andre <jp.andre@samsung.com>
Date: Thu, 16 Feb 2017 07:25:50 +0000 (+0900)
Subject: evas/doc: Add warning about post_event_callback_push
X-Git-Tag: upstream/1.20.0~1987
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=5335352eda4f4e1fe11c0aace94d9e6c1c2e87b9;p=platform%2Fupstream%2Fefl.git

evas/doc: Add warning about post_event_callback_push
---

diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h
index 2140609..3ed05ab 100644
--- a/src/lib/evas/Evas_Legacy.h
+++ b/src/lib/evas/Evas_Legacy.h
@@ -218,6 +218,14 @@ EAPI void *evas_event_callback_del_full(Evas *e, Evas_Callback_Type type, Evas_E
  * callback prepares information ready for taking action, but the post callback
  * actually does the action).
  *
+ * This function should only be called from inside an evas input event
+ * callback. The event_info data may be kept up until @p func is called, in
+ * order to check the state of the "on-hold" flag for instance. Do not modify
+ * the canvas or otherwise trigger or feed a events to the canvas from inside
+ * @p func. Use jobs to safely modify the canvas.
+ *
+ * @warning Only use this function if you know exactly what you are doing!
+ *
  */
 EAPI void  evas_post_event_callback_push(Evas *e, Evas_Object_Event_Post_Cb func, const void *data);