Elm entry: Add a warning to the textblock_get docs.

Thanks to Jihoon Kim for spotting this potential pitfall.

git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/elementary@65288 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

diff --git a/src/lib/Elementary.h.in b/src/lib/Elementary.h.in
index 8916eed..ed111d5 100644 (file)
--- a/src/lib/Elementary.h.in
+++ b/src/lib/Elementary.h.in
@@ -11122,6 +11122,12 @@ extern "C" {
     * functions; The former will either not work at all, or break the correct
     * functionality.
     *
+    * IMPORTANT: Many functions may change (i.e delete and create a new one)
+    * the internal textblock object. Do NOT cache the returned object, and try
+    * not to mix calls on this object with regular elm_entry calls (which may
+    * change the internal textblock object). This applies to all cursors
+    * returned from textblock calls, and all the other derivative values.
+    *
     * @param obj The entry object
     * @return The textblock object.
     */