q66 pushed a commit to branch master. http://git.enlightenment.org/core/elementary.git/commit/?id=eeb4ee393eed1a366fc474e76050a5911bd3097f
commit eeb4ee393eed1a366fc474e76050a5911bd3097f Author: Daniel Kolesa <d.kol...@osg.samsung.com> Date: Wed Aug 5 11:44:39 2015 +0100 list_item: convert docs --- src/lib/elm_list_item.eo | 129 ++++++++++++++++------------------------------- 1 file changed, 43 insertions(+), 86 deletions(-) diff --git a/src/lib/elm_list_item.eo b/src/lib/elm_list_item.eo index 0bb7e4c..50d121a 100644 --- a/src/lib/elm_list_item.eo +++ b/src/lib/elm_list_item.eo @@ -4,116 +4,79 @@ class Elm.List_Item(Elm.Widget_Item) methods { @property separator { get { - /*@ - Get a value whether item is a separator or not. -@see elm_list_item_separator_set() for details. - @ingroup List - */ + [[Get a value whether item is a separator or not.]] } set { - /*@ - Set or unset item as a separator. + [[Set or unset item as a separator. - Items aren't set as separator by default. + Items aren't set as separator by default. - If set as separator it will display separator theme, so won't display - icons or label. - - @see elm_list_item_separator_get() - - @ingroup List - */ + If set as separator it will display separator theme, + so won't display icons or label. + ]] } values { - setting: bool; /*@ @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE - indicates it's not. */ + setting: bool; [[$true means item $it is a separator. + $false indicates it's not.]] } } @property selected { get { - /*@ - Get whether the @p item is selected or not. - - @see elm_list_selected_item_set() for details. - @see elm_list_item_selected_get() - - @ingroup List - */ + [[Get whether the item is selected or not.]] } set { - /*@ - Set the selected state of an item. + [[Set the selected state of an item. - This sets the selected state of the given item @p it. - @c EINA_TRUE for selected, @c EINA_FALSE for not selected. + This sets the selected state of the given item. - If a new item is selected the previously selected will be unselected, - unless multiple selection is enabled with elm_list_multi_select_set(). - Previously selected item can be get with function - elm_list_selected_item_get(). + If a new item is selected the previously selected + will be unselected, unless multiple selection is + enabled with \@ref elm_list_multi_select_set. + Previously selected item can be get with function + \@ref elm_list_selected_item_get. - Selected items will be highlighted. - - @see elm_list_item_selected_get() - @see elm_list_selected_item_get() - @see elm_list_multi_select_set() - - @ingroup List - */ + Selected items will be highlighted. + ]] } values { - selected: bool; /*@ the selected state (@c EINA_TRUE selected, @c EINA_FALSE not selected) */ + selected: bool; [[The selected state.]] } } @property object { get { - /*@ - Get the real Evas(Edje) object created to implement the view of a given - list @p item. - - Base object is the @c Evas_Object that represents that item. + [[Get the real Evas(Edje) object created to implement + the view of a given list item. - @ingroup List - */ + Base object is the $Evas_Object that represents that + item. + ]] } values { - obj: Evas.Object *; /*@ The base Edje object associated with @p it. */ + obj: Evas.Object *; [[The base Edje object associated with the item.]] } } @property prev { get { - /*@ - Get the item before @p it in list. + [[Get the item before the item in list. - @note If it is the first item, @c NULL will be returned. - - @see elm_list_item_append() - @see elm_list_items_get() - - @ingroup List - */ + Note: If it is the first item, $null will be returned. + ]] legacy: elm_list_item_prev; } values { - item: Elm_Object_Item *; /*@ The item before @p it, or @c NULL if none or on failure. */ + item: Elm_Object_Item *; [[The item before or $null.]] } } @property next { get { - /*@ - Get the item after @p it in list. - - @note If it is the last item, @c NULL will be returned. + [[Get the item after the item in list. - @see elm_list_item_append() - @see elm_list_items_get() - - @ingroup List - */ + Note: If it is the last item, $null will be returned. + ]] legacy: elm_list_item_next; } values { - item: Elm_Object_Item *; /*@ The item after @p it, or @c NULL if none or on failure. */ + item: Elm_Object_Item *; [[The item after or $null.]] } } /* init { FIXME @@ -123,28 +86,22 @@ class Elm.List_Item(Elm.Widget_Item) } }*/ show { - /*@ - Show @p item in the list view. - - It won't animate list until item is visible. If such behavior is wanted, - use elm_list_bring_in() instead. + [[Show item in the list view. - @ingroup List - */ + It won't animate list until item is visible. If such + behavior is wanted, use @.bring_in instead. + ]] } bring_in { - /*@ - Bring in the given item to list view. - - This causes list to jump to the given item @p item and show it - (by scrolling), if it is not fully visible. + [[Bring in the given item to list view. - This may use animation to do so and take a period of time. + This causes list to jump to the given item and show it + (by scrolling), if it is not fully visible. - If animation isn't wanted, elm_list_item_show() can be used. + This may use animation to do so and take a period of time. - @ingroup List - */ + If animation isn't wanted, @.show can be used. + ]] } } implements { --