q66 pushed a commit to branch master.
http://git.enlightenment.org/core/elementary.git/commit/?id=a14dc16ff03d936b6cb5164f20264c2dfc5e9702
commit a14dc16ff03d936b6cb5164f20264c2dfc5e9702
Author: Daniel Kolesa <d.kol...@osg.samsung.com>
Date: Wed Aug 5 11:49:28 2015 +0100
menu: convert docs
---
src/lib/elm_menu.eo | 96 +++++++++++++++--------------------------------------
1 file changed, 26 insertions(+), 70 deletions(-)
diff --git a/src/lib/elm_menu.eo b/src/lib/elm_menu.eo
index 1e0e33a..71e19d8 100644
--- a/src/lib/elm_menu.eo
+++ b/src/lib/elm_menu.eo
@@ -4,109 +4,65 @@ class Elm.Menu (Elm.Widget, Evas.Clickable_Interface)
methods {
@property selected_item {
get {
- /*@
- @brief Get the selected item in the menu
-
- @return The selected item, or NULL if none
-
- @see elm_menu_item_selected_get()
- @see elm_menu_item_selected_set()
-
- @ingroup Menu */
- return: Elm_Object_Item *;
+ [[Get the selected item in the menu.]]
+ return: Elm_Object_Item *; [[The selected item or $null.]]
}
}
@property items {
get {
- /*@
- @brief Returns a list of @p item's items.
-
- @return An list* of @p item's items
-
- @ingroup Menu */
+ [[Returns a list of the item's items.]]
return: const(list<Elm_Object_Item *>)*;
}
}
@property first_item {
get {
- /*@
- @brief Get the first item in the menu
-
- @return The first item, or NULL if none
-
- @ingroup Menu */
+ [[Get the first item in the menu.]]
return: Elm_Object_Item *;
}
}
@property last_item {
get {
- /*@
- @brief Get the last item in the menu
-
- @return The last item, or NULL if none
-
- @ingroup Menu */
+ [[Get the last item in the menu.]]
return: Elm_Object_Item *;
}
}
move {
- /*@
- @brief Move the menu to a new position
-
- Sets the top-left position of the menu to (@p x,@p y).
+ [[Move the menu to a new position
- @note @p x and @p y coordinates are relative to parent.
-
- @ingroup Menu */
+ Sets the top-left position of the menu to ($x, $y).
+ Note: $x and $y coordinates are relative to parent.
+ ]]
params {
- @in x: Evas.Coord; /*@ The new position. */
- @in y: Evas.Coord; /*@ The new position. */
+ @in x: Evas.Coord; [[The new position.]]
+ @in y: Evas.Coord; [[The new position.]]
}
}
item_add {
- /*@
- @brief Add an item at the end of the given menu widget
-
- @return Returns the new item.
-
- @note This function does not accept relative icon path.
+ [[Add an item at the end of the given menu widget.
- @ingroup Menu */
-
- return: Elm_Object_Item *;
+ Note: This function does not accept relative icon path.
+ ]]
+ return: Elm_Object_Item *; [[The new menu item.]]
params {
- @in parent: Elm_Object_Item * @optional; /*@ The parent menu item
(optional) */
- @in icon: const(char)* @optional; /*@ An icon display on the item.
The icon will be destroyed by the menu. */
- @in label: const(char)*; /*@ The label of the item. */
- @in func: Evas_Smart_Cb @optional; /*@ Function called when the
user select the item. */
- @in data: const(void)* @optional; /*@ Data sent by the callback. */
+ @in parent: Elm_Object_Item * @optional; [[The parent menu item
(optional).]]
+ @in icon: const(char)* @optional; [[An icon display on the item.
The icon will be destroyed by the menu.]]
+ @in label: const(char)*; [[The label of the item.]]
+ @in func: Evas_Smart_Cb @optional; [[Function called when the user
select the item.]]
+ @in data: const(void)* @optional; [[Data sent by the callback.]]
}
}
close {
- /*@
- @brief Close a opened menu
-
- @return void
-
- Hides the menu and all it's sub-menus.
-
- @ingroup Menu */
+ [[Close a opened menu
+ Hides the menu and all it's sub-menus.
+ ]]
}
item_separator_add {
- /*@
- @brief Add a separator item to menu @p obj under @p parent.
-
- @return The created item or NULL on failure
-
- This is item is a @ref Separator.
-
- @ingroup Menu */
-
- return: Elm_Object_Item *;
+ [[Add a separator item to menu $obj under $parent.]]
+ return: Elm_Object_Item *; [[The created item or $null.]]
params {
- @in parent: Elm_Object_Item *; /*@ The item to add the separator
under */
+ @in parent: Elm_Object_Item *; [[The item to add the separator
under.]]
}
}
}
--
