tasn pushed a commit to branch master. http://git.enlightenment.org/core/elementary.git/commit/?id=3403056898a492fc14d8e712f660465ee5943286
commit 3403056898a492fc14d8e712f660465ee5943286 Author: Tom Hacohen <t...@stosb.com> Date: Thu Aug 6 14:47:09 2015 +0100 Hoversel: migrate docs. --- src/lib/elm_hoversel.eo | 141 +++++++++++++----------------------------------- 1 file changed, 36 insertions(+), 105 deletions(-) diff --git a/src/lib/elm_hoversel.eo b/src/lib/elm_hoversel.eo index 59b9bee..324b4da 100644 --- a/src/lib/elm_hoversel.eo +++ b/src/lib/elm_hoversel.eo @@ -5,154 +5,85 @@ class Elm.Hoversel (Elm.Button, Evas.Selectable_Interface, eo_prefix: elm_obj_hoversel; methods { @property horizontal { - set { - /*@ - @brief This sets the hoversel to expand horizontally. - - @note The initial button will display horizontally regardless of this - setting. + [[Control if the hoversel should expand horizontally. - @ingroup Hoversel */ + Note: The initial button will display horizontally regradless of this setting.]] + set { } get { - /*@ - @brief This returns whether the hoversel is set to expand horizontally. - - @return If true, the hover will expand horizontally to the right. - - @see elm_hoversel_horizontal_set() - - @ingroup Hoversel */ } values { - horizontal: bool; /*@ If true, the hover will expand horizontally to the - right. */ + horizontal: bool; [[If $true, the hover will expand horizontally to the right.]] } } @property hover_parent { - set { - /*@ - @brief Set the Hover parent - - Sets the hover parent object, the area that will be darkened when the - hoversel is clicked. Should probably be the window that the hoversel is - in. See @ref Hover objects for more information. + [[Control the hover parent. - @ingroup Hoversel */ + Sets the hover parent object, the area that will be darkened when the + hoversel is clicked. Should probably be the window that the hoversel is + in.]] + set { } get { - /*@ - @brief Get the Hover parent - - @return The used parent - - Get the hover parent object. - - @see elm_hoversel_hover_parent_set() - - @ingroup Hoversel */ } values { - parent: Evas.Object * @nullable; /*@ The parent to use */ + parent: Evas.Object * @nullable; [[The parent to use]] } } @property expanded { get { - /*@ - @brief Returns whether the hoversel is expanded. - - @return This will return @c EINA_TRUE if the hoversel is expanded or - @c EINA_FALSE if it is not expanded. - - @ingroup Hoversel */ - return: bool; + [[Returns whether the hoversel is expanded.]] + return: bool; [[$true if the hoversel is expanded or $false otherwise]] } } @property items { get { - /*@ - @brief Get the list of items within the given hoversel. - - @return Returns a list of Elm.Widget_Item - - @see elm_hoversel_item_add() - - @ingroup Hoversel */ + [[Get the list of items within the given hoversel.]] return: const(list<Elm.Widget_Item *>)*; } } @property scroll_enabled { - get { - /*@ - @brief Limit the size of contents and make them scrollable. + [[Control wether scrolling is enabled. - @ingroup Hoversel */ + This Limit the size of contents and make them scrollable.]] + get { } set { - /*@ - @brief Returns whether the contents of hoversel are scrollable or not. - - @return @c EINA_TRUE scrollable. @c EINA_FALSE otherwise. - - @ingroup Hoversel */ } values { - scroll_enabled: bool; + scroll_enabled: bool; [[$true if scrollable $false otherwise.]] } } hover_begin { - /*@ - @brief This triggers the hoversel popup from code, the same as if the user - had clicked the button. - - @ingroup Hoversel */ - + [[This triggers the hoversel popup from code, the same as if the user had clicked the button.]] } clear { - /*@ - @brief This will remove all the children items from the hoversel. - - @warning Should @b not be called while the hoversel is active; use - elm_hoversel_expanded_get() to check first. - - @see elm_object_item_del() - - @ingroup Hoversel */ + [[This will remove all the children items from the hoversel. + Warning Should *not* be called while the hoversel is active; use + @Elm.Hoversel.expanded.get to check first.]] } hover_end { - /*@ - @brief This dismisses the hoversel popup as if the user had clicked - outside the hover. - - @ingroup Hoversel */ - + [[This dismisses the hoversel popup as if the user had clicked outside the hover.]] } item_add { - /*@ - @brief Add an item to the hoversel button - - @return A handle to the item added. - - This adds an item to the hoversel to show when it is clicked. Note: if you - need to use an icon from an edje file then use - elm_hoversel_item_icon_set() right after this function, and set - icon_file to NULL here. - - For more information on what @p icon_file and @p icon_type are, see the - @ref Icon "icon documentation". + [[Add an item to the hoversel button - @ingroup Hoversel */ + This adds an item to the hoversel to show when it is clicked. Note: if you + need to use an icon from an edje file then use Elm.Hoversel_Item.icon.set + right after this function, and set icon_file to $null here.]] - return: Elm.Widget_Item *; + /* FIXME: Make the hoversel_item reference in the doc a real ref. */ + /* FIXME-doc + For more information on what @p icon_file and @p icon_type are, see the + @ref Icon "icon documentation". */ + return: Elm.Widget_Item *; [[A handle to the added item.]] params { - @in label: const(char)* @optional; /*@ The text label to use for the item (NULL if not desired) */ - @in icon_file: const(char)* @optional; /*@ An image file path on disk to use for the icon or standard - icon name (NULL if not desired) */ - @in icon_type: Elm_Icon_Type; /*@ The icon type if relevant */ - @in func: Evas_Smart_Cb @optional; /*@ Convenience function to call when this item is selected. The last - parameter @p event_info of @c func is the selected item pointer. */ - @in data: const(void)* @optional; /*@ Data to pass to item-related functions */ + @in label: const(char)* @optional; [[The text label to use for the item (NULL if not desired)]] + @in icon_file: const(char)* @optional; [[An image file path on disk to use for the icon or standard icon name (NULL if not desired)]] + @in icon_type: Elm_Icon_Type; [[The icon type if relevant]] + @in func: Evas_Smart_Cb @optional; [[Convenience function to call when this item is selected. The last parameter $event_info of $func is the selected item pointer.]] + @in data: const(void)* @optional; [[Data to pass to item-related functions]] } } } --