Genlist: fix doc for item_next/prev_get()
authorDave Andreoli <dave@gurumeditation.it>
Sat, 28 Apr 2018 08:31:23 +0000 (10:31 +0200)
committerWonki Kim <wonki_.kim@samsung.com>
Thu, 31 May 2018 05:49:20 +0000 (14:49 +0900)
See T5938 for details

src/lib/elementary/elm_genlist_item.eo

index b9e8454..7a58893 100644 (file)
@@ -18,6 +18,12 @@ class Elm.Genlist.Item(Elm.Widget.Item.Static_Focus, Efl.Ui.Legacy)
                        If filter is set on genlist, this returns the filtered
                        item placed before $item in the list.
 
+                       Note that parent / child relationship is not taken into
+                       account, the previous visual item is always returned,
+                       could it be a parent, a child or a group item.
+
+                       NULL is returned if called on the first item.
+
                        \@if MOBILE \@since_tizen 2.3
                        \@elseif WEARABLE \@since_tizen 2.3.1
                        \@endif
@@ -43,6 +49,12 @@ class Elm.Genlist.Item(Elm.Widget.Item.Static_Focus, Efl.Ui.Legacy)
                        will be ignore, and will get the next item in the same
                        level.
 
+                       Note that parent / child relationship is not taken into
+                       account, the next visual item is always returned, could
+                       it be a parent, a child or a group item.
+
+                       NULL is returned if called on the last item.
+
                        \@if MOBILE \@since_tizen 2.3
                        \@elseif WEARABLE \@since_tizen 2.3.1
                        \@endif
@@ -72,7 +84,7 @@ class Elm.Genlist.Item(Elm.Widget.Item.Static_Focus, Efl.Ui.Legacy)
            }
            @property subitems {
                 get {
-                     [[et the list of subitems of a given item
+                     [[Get the list of subitems of a given item
 
                        This returns the list of subitems that an item
                        possesses. It cannot be changed.