widget item: add missing @since_tizen tags to some of elm_object_item_* APIs 18/190118/1
authorYoungbok Shin <youngb.shin@samsung.com>
Thu, 27 Sep 2018 06:00:33 +0000 (15:00 +0900)
committerYoungbok Shin <youngb.shin@samsung.com>
Thu, 27 Sep 2018 06:00:33 +0000 (15:00 +0900)
@tizen_fix

Change-Id: I0a733fcfc9da19bbe096fb3aace2828acc98032a

src/lib/elm_widget_item.eo

index c95bf7d..473b58c 100644 (file)
@@ -12,11 +12,14 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
       legacy_prefix: elm_object_item;
       methods {
            @property tooltip_window_mode {
-               [[Control size restriction state of an object's tooltip
+                [[Control size restriction state of an object's tooltip
 
-                 This function returns whether a tooltip is allowed to expand beyond
-                 its parent window's canvas.
-                 It will instead be limited only by the size of the display.]]
+                  This function returns whether a tooltip is allowed to expand beyond
+                  its parent window's canvas.
+                  It will instead be limited only by the size of the display.
+
+                  \@since_tizen 2.3
+                ]]
                 get {
                 }
                 set {
@@ -33,7 +36,10 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
                   @.tooltip_content_cb_set or
                   @.tooltip_text_set
 
-                  See: elm_object_tooltip_style_set() for more details.]]
+                  See: elm_object_tooltip_style_set() for more details.
+
+                  \@since_tizen 2.3
+                ]]
                 get {
                 }
                 set {
@@ -53,7 +59,10 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
                   item with custom cursor set will always show that cursor.
 
                   If this function is called twice for an object, a previously set
-                  cursor will be unset on the second call.]]
+                  cursor will be unset on the second call.
+
+                  \@since_tizen 2.3
+                ]]
                 get {
                 }
                 set {
@@ -72,7 +81,10 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
                   applies only to item objects.
 
                   Warning: Before you set a cursor style you should have defined a
-                  custom cursor previously on the item, with @.cursor.set]]
+                  custom cursor previously on the item, with @.cursor.set
+
+                  \@since_tizen 2.3
+                ]]
                 get {
                 }
                 set {
@@ -90,7 +102,10 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
                   for items, with @.cursor.set.
 
                   Note: By default, cursors will only be looked for between those
-                  provided by the rendering engine.]]
+                  provided by the rendering engine.
+
+                  \@since_tizen 2.3
+                ]]
                 get {
                 }
                 set {
@@ -191,15 +206,21 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
                 }
            }
            access_order_get @const {
-                  [[Get highlight order
+                [[Get highlight order
 
-                    @since 1.8]]
+                  \@since_tizen 2.3
+
+                  @since 1.8
+                ]]
                 return: const(list<Evas.Object *>) *;
            }
            access_order_set {
                 [[Set highlight order
 
-                  @since 1.8]]
+                  \@since_tizen 2.3
+
+                  @since 1.8
+                ]]
                 params {
                      @in objs: own(list<Evas.Object *> *); [[Order of objects to pass highlight]]
                 }
@@ -229,7 +250,10 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
                   so any previous tooltip data - set with this function or
                   @.tooltip_content_cb_set - is removed.
 
-                  See: elm_object_tooltip_text_set() for more details.]]
+                  See: elm_object_tooltip_text_set() for more details.
+
+                  \@since_tizen 2.3
+                ]]
                 params {
                      text: const (char) *; [[The text to set in the content.]]
                 }
@@ -249,7 +273,10 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
                   it is not used anymore.
 
                   See: elm_object_tooltip_unset() for more details.
-                  See: @.tooltip_content_cb_set]]
+                  See: @.tooltip_content_cb_set
+
+                  \@since_tizen 2.3
+                ]]
            }
            cursor_unset {
                 [[Unset any custom mouse pointer/cursor decoration set to be
@@ -260,7 +287,10 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
                   decoration, bringing it back to defaults (no custom style set).
 
                   See: elm_object_cursor_unset()
-                  See: @.cursor.set]]
+                  See: @.cursor.set
+
+                  \@since_tizen 2.3
+                ]]
            }
            part_content_unset {
                 [[Unset a content of an object item
@@ -302,7 +332,10 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
 
                   See: @.signal_callback_add
 
-                  @since 1.8]]
+                  \@since_tizen 2.3
+
+                  @since 1.8
+                ]]
                 params {
                      emission: const (char) *; [[The signal's name.]]
                      source: const (char) *; [[The signal's source.]]
@@ -322,7 +355,10 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
                 }
            }
            access_info_set {
-                [[Set the text to read out when in accessibility mode]]
+                [[Set the text to read out when in accessibility mode
+
+                  \@since_tizen 2.3
+                ]]
                 params {
                      txt: const (char) *; [[The text that describes the widget to people with poor or no vision]]
                 }
@@ -330,7 +366,10 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
            access_object_get @const {
                 [[Get an accessible object of the object item.
 
-                  @since 1.8]]
+                  \@since_tizen 2.3
+
+                  @since 1.8
+                ]]
                 return: Evas.Object*; [[Accessible object of the object item or NULL for any error]]
            }
            domain_translatable_part_text_set {
@@ -348,7 +387,10 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
                   its own translatable strings, that should not be mixed with those of programs
                   using the library.
 
-                  @since 1.8]]
+                  \@since_tizen 2.3
+
+                  @since 1.8
+                ]]
                 params {
                      part: const (char) *; [[The name of the part to set]]
                      domain: const (char) *; [[The translation domain to use]]
@@ -362,7 +404,10 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
                   will return the translation returned by $gettext(). To get the original
                   string use this function.
 
-                  @since 1.8]]
+                  \@since_tizen 2.3
+
+                  @since 1.8
+                ]]
                 params {
                      part: const (char) *; [[The name of the part that was set]]
                 }
@@ -385,7 +430,10 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
                   See: @.part_text.set
                   See: elm_policy()
 
-                  @since 1.8]]
+                  \@since_tizen 2.3
+
+                  @since 1.8
+                ]]
                 params {
                      part: const (char) *; [[The part name of the translatable text]]
                      domain: const (char) *; [[The translation domain to use]]
@@ -416,7 +464,10 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
                   See: @.untrack
                   See: @.track_get
 
-                  @since 1.8]]
+                  \@since_tizen 2.3
+
+                  @since 1.8
+                ]]
                 return: Evas.Object*; [[The track object]]
            }
            untrack {
@@ -428,7 +479,10 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
                   See: @.track
                   See: @.track_get
 
-                  @since 1.8]]
+                  \@since_tizen 2.3
+
+                  @since 1.8
+                ]]
            }
            track_get @const {
                 [[Get the track object reference count.
@@ -444,7 +498,10 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
                   See: @.track
                   See: @.track_get
 
-                  @since 1.8]]
+                  \@since_tizen 2.3
+
+                  @since 1.8
+                ]]
                 return: int;
            }
            track_cancel @protected {
@@ -469,7 +526,10 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
                   return a valid Evas_Object. This object is then managed fully by
                   tooltip system and is deleted when the tooltip is gone.
 
-                  See: elm_object_tooltip_content_cb_set() for more details.]]
+                  See: elm_object_tooltip_content_cb_set() for more details.
+
+                  \@since_tizen 2.3
+                ]]
                 params {
                      func: Elm_Tooltip_Item_Content_Cb @nullable; [[the function used to create the tooltip contents.]]
                      data: const (void) * @optional; [[what to provide to $func as callback data/context.]]
@@ -480,18 +540,27 @@ class Elm.Widget_Item (Eo.Base, Elm_Interface_Atspi_Accessible,
            access_register {
                 [[Register object item as an accessible object.
 
-                  @since 1.8]]
+                  \@since_tizen 2.3
+
+                  @since 1.8
+                ]]
                 return: Evas.Object*; [[Accessible object of the object item or NULL for any error]]
            }
            access_unregister {
                 [[Unregister accessible object of the object item.
 
-                  @since 1.8]]
+                  \@since_tizen 2.3
+
+                  @since 1.8
+                ]]
            }
            access_order_unset {
                 [[Unset highlight order
 
-                  @since 1.8]]
+                  \@since_tizen 2.3
+
+                  @since 1.8
+                ]]
            }
            disable @protected {
                 legacy: null;