edje_object : fix doxygen warning

Change-Id: I080d56e8b3d3b8022c52ce328bab51cbc0dd75f2

diff --git a/src/lib/edje/edje_object.eo b/src/lib/edje/edje_object.eo
index c1c4824..aa078b1 100644 (file)
--- a/src/lib/edje/edje_object.eo
+++ b/src/lib/edje/edje_object.eo
@@ -212,7 +212,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
                \@elseif WEARABLE \@since_tizen 2.3.1
                \@endif
              ]]
-            return: bool;
+            return: bool; [[$true, on success or $false, on error]]
          }
          get {
             [[Gets a given Edje object's scaling factor.
@@ -641,7 +641,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
                                  "" for other states]]
          params {
             @in part: const(char)*; [[The part name]]
-            @out val_ret: double;
+            @out val_ret: double; [[The description state value]]
          }
       }
       text_markup_filter_callback_del_full {
@@ -683,7 +683,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
            \@endif
          ]]
 
-         return: bool;
+         return: bool; [[$true, on success or $false, on error]]
          params {
             @in part: const(char)*; [[The part name]]
             @in dx: double; [[The x step amount]]
@@ -701,7 +701,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
            \@elseif WEARABLE \@since_tizen 2.3.1
            \@endif
          ]]
-           return: bool;
+           return: bool; [[$true, on success or $false, on error]]
          params {
             @in part: const(char)*; [[The part]]
             @out dx: double; [[The x step increment pointer]]
@@ -782,7 +782,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
             \@endif
           ]]
 
-         return: bool;
+         return: bool; [[$true, on success or $false, on error]]
          params {
             @in part: const(char)*; [[The part name]]
             @in cur: Edje.Cursor; [[The edje cursor to advance]]
@@ -841,7 +841,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
            \@elseif WEARABLE \@since_tizen 2.3.1
            \@endif
          ]]
-         return: bool;
+         return: bool; [[$true, on success or $false, on error]]
          params {
             @in part: const(char)*; [[The Edje part's name]]
             @out x: Evas.Coord; [[A pointer to a variable where to store the part's x
@@ -1057,7 +1057,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
            \@endif
          ]]
 
-         return: bool;
+         return: bool; [[$true, on success or $false, on error]]
          params {
             @out x: Evas.Coord; [[A pointer to a variable where to store the parts region's
                                   x coordinate]]
@@ -1091,7 +1091,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
            \@endif
          ]]
 
-         return: bool;
+         return: bool; [[$true, on success or $false, on error]]
          params {
             @in part: const(char)*; [[The part name]]
             @in dx: double; [[The x value]]
@@ -1112,7 +1112,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
            \@elseif WEARABLE \@since_tizen 2.3.1
            \@endif
          ]]
-         return: bool;
+         return: bool; [[$true, on success or $false, on error]]
          params {
             @in part: const(char)*; [[The part name]]
             @out dx: double; [[The X value pointer]]
@@ -1333,7 +1333,8 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
            \@elseif WEARABLE \@since_tizen 3.0
            \@endif
          ]]
-         return: Evas.Object *;
+         return: Evas.Object *; [[The externally created content object, or $null if there is none or
+                                  part is not an external.]]
          params {
             @in part: const(char)*; [[The name of the part holding the EXTERNAL]]
             @out content: const(char); [[A string identifying which content from the EXTERNAL to get]]
@@ -1449,7 +1450,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
            \@endif
          ]]
 
-         return: bool;
+         return: bool; [[$true, on success or $false, on error]]
          params {
             @in part: const(char)*; [[The part name]]
             @in cur: Edje.Cursor; [[The edje cursor to work on]]
@@ -1471,7 +1472,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
            \@endif
          ]]
 
-         return: bool;
+         return: bool; [[$true, on success or $false, on error]]
          params {
             @in part: const(char)*; [[The part name]]
             @in dx: double; [[The x page step increment]]
@@ -1489,7 +1490,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
            \@elseif WEARABLE \@since_tizen 2.3.1
            \@endif
          ]]
-         return: bool;
+         return: bool; [[$true, on success or $false, on error]]
          params {
             @in part: const(char)*; [[The part name]]
             @out dx: double; [[The dx page increment pointer]]
@@ -1661,7 +1662,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
            \@endif
          ]]
 
-         return: bool;
+         return: bool; [[$true, on success or $false, on error]]
          params {
             @in part: const(char)*; [[The part name]]
             @in dw: double; [[The drag width]]
@@ -1679,7 +1680,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
            \@elseif WEARABLE \@since_tizen 2.3.1
            \@endif
          ]]
-         return: bool;
+         return: bool; [[$true, on success or $false, on error]]
          params {
             @in part: const(char)*; [[The part name]]
             @out dw: double; [[The drag width pointer]]
@@ -1738,7 +1739,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
            \@endif
          ]]
 
-         return: bool;
+         return: bool; [[$true, on success or $false, on error]]
          params {
             @in part: const(char)*; [[The part name]]
             @in text_to_escape: const(char)*; [[The text string]]
@@ -2356,7 +2357,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
            \@endif
          ]]
 
-         return: bool;
+         return: bool; [[$true, on success or $false, on error]]
          params {
             @in part: const(char)*; [[The part name]]
             @in dx: double; [[The x step]]
@@ -2524,9 +2525,9 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
            \@endif
          ]]
 
-         return: bool;
+         return: bool; [[$true, on success or $false, on error]]
          params {
-            @in color_class: const(char)*;
+            @in color_class: const(char)*; [[The color class name]]
             @in r: int; [[Object Red value]]
             @in g: int; [[Object Green value]]
             @in b: int; [[Object Blue value]]
@@ -2562,7 +2563,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
          return: bool; [[$true if found, or $false if not found and all
                          values are zeroed.]]
          params {
-            @in color_class: const(char)*;
+            @in color_class: const(char)*; [[The color class name]]
             @out r: int; [[Object Red value]]
             @out g: int; [[Object Green value]]
             @out b: int; [[Object Blue value]]
@@ -2588,7 +2589,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
          ]]
          return: const(char)*; [[The description of the target color class or $null if not found]]
          params {
-            @in color_class: const(char)*;
+            @in color_class: const(char)*; [[The color class name]]
          }
       }
       color_class_clear @const {
@@ -2699,7 +2700,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
            \@endif
          ]]
 
-         return: bool;
+         return: bool; [[$true, on success or $false, on error]]
          params {
             @in part: const(char)*; [[The part name]]
             @in dx: double; [[The x step]]
@@ -2714,7 +2715,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
            \@endif
          ]]
 
-         return: bool;
+         return: bool; [[$true, on success or $false, on error]]
          params {
             @in part: const(char)*; [[The part name]]
             @in cur: Edje.Cursor; [[The edje cursor to work on]]
@@ -2877,7 +2878,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
            \@elseif WEARABLE \@since_tizen 3.0
            \@endif
          ]]
-         return: bool;
+         return: bool; [[Returns $true if the cursor points to a visible format or $false on error]]
          params {
             @in part: const(char)*; [[The part name]]
             @in cur: Edje.Cursor; [[The cursor to adjust.]]
@@ -2909,7 +2910,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
             \@endif
           ]]
 
-         return: bool;
+         return: bool; [[$true, on success or $false, on error]]
          params {
             @in part: const(char)*; [[The part name]]
             @in cur: Edje.Cursor; [[The edje cursor to work on]]
@@ -2966,7 +2967,7 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
             \@endif
           ]]
 
-         return: bool;
+         return: bool; [[$true, on success or $false, on error]]
          params {
             @in part: const(char)*; [[The swallow part's name]]
             @in obj_swallow: Evas.Object *; [[The object to occupy that part]]