elm_entry_common.h: added more description to elm_entry_utf8_to_markup api.

diff --git a/src/lib/elm_entry_common.h b/src/lib/elm_entry_common.h
index 1f79b31..3c49e8b 100644 (file)
--- a/src/lib/elm_entry_common.h
+++ b/src/lib/elm_entry_common.h
@@ -240,6 +240,11 @@ EAPI char              *elm_entry_markup_to_utf8(const char *s);
  * @param s The string (in UTF-8) to be converted
  * @return The converted string (in markup). It should be freed.
  *
+ * For example, passing "<align=center>hello</align>&gt;" will return
+ * "&lt;align=center&gt;hello&lt;/align&gt; &amp;gt;". This is useful when you
+ * want to display "&" in label, entry, and some widgets which use textblock
+ * internally.
+ *
  * @ingroup Entry
  */
 EAPI char              *elm_entry_utf8_to_markup(const char *s);