From: Stefan Schmidt <stefan@osg.samsung.com>
Date: Mon, 24 Oct 2016 14:52:48 +0000 (+0200)
Subject: docs: eo: make consistent use of $true in docs
X-Git-Tag: upstream/1.20.0~3948
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=ea7c0ca516fae86bc99c6328accda259bd0d5de2;p=platform%2Fupstream%2Fefl.git

docs: eo: make consistent use of $true in docs

Make use of the $true keyword instead of going with Ein_True or just true. We
need to change this tree-wide in the docs.
---

diff --git a/src/lib/eo/efl_object.eo b/src/lib/eo/efl_object.eo
index 537a179..703c53f 100644
--- a/src/lib/eo/efl_object.eo
+++ b/src/lib/eo/efl_object.eo
@@ -3,9 +3,9 @@ import eina_types;
 struct Efl.Event.Description {
     [[This struct holds the description of a specific event.]]
     name: string; [[name of the event.]]
-    unfreezable: bool; [[Eina_True if the event cannot be frozen.]]
-    legacy_is: bool; [[Internal use: if is a legacy event.]]
-    restart: bool; [[Eina_True if when the event is triggered again from a callback, it should start from where it was]]
+    unfreezable: bool; [[$true if the event cannot be frozen.]]
+    legacy_is: bool; [[Internal use: $true if a legacy event.]]
+    restart: bool; [[$true if when the event is triggered again from a callback, it should start from where it was]]
 }
 
 struct Efl.Event {
@@ -322,7 +322,7 @@ abstract Efl.Object ()
            callbacks of the same priority are called in reverse order of
            creation.
          ]]
-         return: bool; [[Return true when the callback has been successfully added.]]
+         return: bool; [[Return $true when the callback has been successfully added.]]
          params {
             @in desc: ref(const(Efl.Event.Description)); [[The description of the event to listen to]]
             @in priority: Efl.Callback_Priority; [[The priority of the callback]]
@@ -332,7 +332,7 @@ abstract Efl.Object ()
       }
       event_callback_del {
          [[Del a callback with a specific data associated to it for an event.]]
-         return: bool; [[Return true when the callback has been successfully removed.]]
+         return: bool; [[Return $true when the callback has been successfully removed.]]
          params {
             @in desc: ref(const(Efl.Event.Description)); [[The description of the event to listen to]]
             @in func: Efl.Event_Cb; [[the callback to delete]]
@@ -347,7 +347,7 @@ abstract Efl.Object ()
            callbacks of the same priority are called in reverse order of
            creation.
          ]]
-         return: bool; [[Return true when the callback has been successfully added.]]
+         return: bool; [[Return $true when the callback has been successfully added.]]
          params {
             @in array: ref(const(Efl.Callback_Array_Item)); [[an #Efl_Callback_Array_Item of events to listen to]]
             @in priority: Efl.Callback_Priority; [[The priority of the callback]]
@@ -358,7 +358,7 @@ abstract Efl.Object ()
          [[Del a callback array with a specific data associated to it for an
            event.
          ]]
-         return: bool; [[Return true when the callback has been successfully removed.]]
+         return: bool; [[Return $true when the callback has been successfully removed.]]
          params {
             @in array: ref(const(Efl.Callback_Array_Item)); [[an #Efl_Callback_Array_Item of events to listen to]]
             @in user_data: const(void_ptr); [[The data to compare]]