q66 pushed a commit to branch master.
http://git.enlightenment.org/core/elementary.git/commit/?id=110fb9499fb0097a181d55960f8bac642850fe19
commit 110fb9499fb0097a181d55960f8bac642850fe19
Author: Vivek Ellur <vivek.el...@samsung.com>
Date: Mon Jul 27 10:18:37 2015 +0100
elm_ctxpopup: convert eo docs to new format
Summary:
Converted docs of elm_ctxpopup.eo and elm_ctxpopup_item.eo to new format
Signed-off-by: Vivek Ellur <vivek.el...@samsung.com>
Reviewers: cedric, q66
Reviewed By: q66
Differential Revision: https://phab.enlightenment.org/D2862
---
src/lib/elm_ctxpopup.eo | 240 ++++++++++++++++++-------------------------
src/lib/elm_ctxpopup_item.eo | 30 +++---
2 files changed, 112 insertions(+), 158 deletions(-)
diff --git a/src/lib/elm_ctxpopup.eo b/src/lib/elm_ctxpopup.eo
index 916272c..bd89305 100644
--- a/src/lib/elm_ctxpopup.eo
+++ b/src/lib/elm_ctxpopup.eo
@@ -14,241 +14,201 @@ class Elm.Ctxpopup (Elm.Layout,
Elm_Interface_Atspi_Widget_Action)
methods {
@property horizontal {
set {
- /*@
- @brief Change the ctxpopup's orientation to horizontal or vertical.
-
- @ingroup Ctxpopup */
+ [[Change the ctxpopup's orientation to horizontal or vertical.]]
}
get {
- /*@
- @brief Get the value of current ctxpopup object's orientation.
-
- @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for
vertical mode (or errors)
+ [[Get the value of current ctxpopup object's orientation.
- @see elm_ctxpopup_horizontal_set()
-
- @ingroup Ctxpopup */
+ See also @.horizontal.set.
+ ]]
}
values {
- horizontal: bool; /*@ @c EINA_TRUE for horizontal mode, @c
EINA_FALSE for vertical */
+ horizontal: bool; [[$true for horizontal mode, $false for
vertical.]]
}
}
@property auto_hide_disabled {
set {
- /*@
- @brief Set ctxpopup auto hide mode triggered by ctxpopup policy.
- @since 1.9
+ [[Set ctxpopup auto hide mode triggered by ctxpopup policy.
- Use this function when user wants ctxpopup not to hide
automatically.
- By default, ctxpopup is dismissed whenever mouse clicked its
background area, language is changed,
- and its parent geometry is updated(changed).
- Not to hide ctxpopup automatically, disable auto hide function by
calling this API,
- then ctxpopup won't be dismissed in those scenarios.
+ Use this function when user wants ctxpopup not to hide
automatically.
+ By default, ctxpopup is dismissed whenever mouse clicked its
background area, language is changed,
+ and its parent geometry is updated(changed).
+ Not to hide ctxpopup automatically, disable auto hide function
by calling this API,
+ then ctxpopup won't be dismissed in those scenarios.
- Default value of disabled is @c EINA_FALSE.
+ Default value of disabled is $false.
- @see elm_ctxpopup_auto_hide_disabled_get()
+ See also @.auto_hide_disabled.get.
- @ingroup Ctxpopup */
+ @since 1.9
+ ]]
}
get {
- /*@
- @brief Get ctxpopup auto hide mode triggered by ctxpopup policy.
- @since 1.9
-
- @return auto hide mode's state of a ctxpopup
+ [[Get ctxpopup auto hide mode triggered by ctxpopup policy.
- @see elm_ctxpopup_auto_hide_disabled_set() for more information.
+ See also @.auto_hide_disabled.set for more information.
- @ingroup Ctxpopup */
+ @since 1.9
+ ]]
}
values {
- disabled: bool; /*@ auto hide enable/disable. */
+ disabled: bool; [[auto hide enable/disable.]]
}
}
@property hover_parent {
set {
- /*@
- @brief Set the Ctxpopup's parent
+ [[Set the Ctxpopup's parent
- Set the parent object.
+ Set the parent object.
- @note elm_ctxpopup_add() will automatically call this function
- with its @c parent argument.
+ Note: \@ref elm_ctxpopup_add will automatically call this
function
+ with its $parent argument.
- @see elm_ctxpopup_add()
- @see elm_hover_parent_set()
-
- @ingroup Ctxpopup */
+ See also \@ref elm_ctxpopup_add,
+ \@ref elm_hover_parent_set.
+ ]]
}
get {
- /*@
- @brief Get the Ctxpopup's parent
-
- @see elm_ctxpopup_hover_parent_set() for more information
+ [[Get the Ctxpopup's parent
- @ingroup Ctxpopup */
+ See also @.hover_parent.set for more information
+ ]]
}
values {
- parent: Evas.Object *; /*@ The parent to use */
+ parent: Evas.Object *; [[The parent to use.]]
}
}
@property direction_priority {
set {
- /*@
- @brief Set the direction priority of a ctxpopup.
-
- This functions gives a chance to user to set the priority of
ctxpopup
- showing direction. This doesn't guarantee the ctxpopup will appear
in the
- requested direction.
+ [[Set the direction priority of a ctxpopup.
- @see Elm.Ctxpopup.Direction
+ This functions gives a chance to user to set the priority of
ctxpopup
+ showing direction. This doesn't guarantee the ctxpopup will
appear in the
+ requested direction.
- @ingroup Ctxpopup */
+ See also @.Direction.
+ ]]
}
get {
- /*@
- @brief Get the direction priority of a ctxpopup.
+ [[Get the direction priority of a ctxpopup.
- @see elm_ctxpopup_direction_priority_set() for more information.
-
- @ingroup Ctxpopup */
+ See also @.direction_priority.set for more information.
+ ]]
}
values {
- first: Elm.Ctxpopup.Direction; /*@ 1st priority of direction */
- second: Elm.Ctxpopup.Direction; /*@ 2nd priority of direction */
- third: Elm.Ctxpopup.Direction; /*@ 3th priority of direction */
- fourth: Elm.Ctxpopup.Direction; /*@ 4th priority of direction */
+ first: Elm.Ctxpopup.Direction; [[1st priority of direction]]
+ second: Elm.Ctxpopup.Direction; [[2nd priority of direction]]
+ third: Elm.Ctxpopup.Direction; [[3th priority of direction]]
+ fourth: Elm.Ctxpopup.Direction; [[4th priority of direction]]
}
}
@property direction {
get {
- /*@
- @brief Get the current direction of a ctxpopup.
-
- @return current direction of a ctxpopup
- (If getting the current direction is failed, it returns
#ELM_CTXPOPUP_DIRECTION_UNKNOWN)
+ [[Get the current direction of a ctxpopup.
- @warning Once the ctxpopup showed up, the direction would be
determined
+ Warning: Once the ctxpopup showed up, the direction would be
determined
- @ingroup Ctxpopup */
+ ]]
return: Elm.Ctxpopup.Direction(Elm.Ctxpopup.Direction.unknown);
}
}
@property items {
get {
- /*@
- @brief Get the internal list of items in a given ctxpopup widget.
- @since 1.11
+ [[Get the internal list of items in a given ctxpopup widget.
- @return The list of items (#Elm_Object_Item as data) or
- @c NULL on errors.
+ This list is not to be modified in any way and must not be
+ freed. Use the list members with functions like
+ \@ref elm_object_item_text_set,
+ \@ref elm_object_item_text_get,
+ \@ref elm_object_item_del.
- This list is @b not to be modified in any way and must not be
- freed. Use the list members with functions like
- elm_object_item_text_set(),
- elm_object_item_text_get(),
- elm_object_item_del().
+ Warning: This list is only valid until $obj object's internal
+ items list is changed. It should be fetched again with another
+ call to this function when changes happen.
- @warning This list is only valid until @p obj object's internal
- items list is changed. It should be fetched again with another
- call to this function when changes happen.
+ @since 1.11
+ ]]
+ return: const(list<Elm.Object.Item*>)*; [[The list of items or
+ $null on errors.]]
- @ingroup Ctxpopup */
- return: const(list<Elm.Object.Item*>)*;
}
}
@property first_item {
get {
- /*@
- Get the first item in the given ctxpopup widget's list of
- items.
- @since 1.11
+ [[Get the first item in the given ctxpopup widget's list of
+ items.
- @return The first item or @c NULL, if it has no items (and on
- errors)
+ See also @.item_append,
+ @.last_item.get.
- @see elm_ctxpopup_item_append()
- @see elm_ctxpopup_last_item_get()
+ @since 1.11
+ ]]
+ return: Elm_Object_Item *; [[The first item or $null, if it has no
items (and on
+ errors).]]
- @ingroup Ctxpopup */
- return: Elm_Object_Item *;
}
}
@property last_item {
get {
- /*@
- Get the last item in the given ctxpopup widget's list of
- items.
- @since 1.11
+ [[Get the last item in the given ctxpopup widget's list of
+ items.
- @return The last item or @c NULL, if it has no items (and on
- errors)
+ See also @.item_prepend,
+ @.first_item.get.
- @see elm_ctxpopup_item_prepend()
- @see elm_ctxpopup_first_item_get()
+ @since 1.1
+ ]]
+ return: Elm_Object_Item *; [[The last item or $null, if it has no
items (and on
+ errors).]]
- @ingroup Ctxpopup */
- return: Elm_Object_Item *;
}
}
dismiss {
- /*@
- @brief Dismiss a ctxpopup object
+ [[Dismiss a ctxpopup object
Use this function to simulate clicking outside of the ctxpopup to
dismiss it.
In this way, the ctxpopup will be hidden and the "clicked" signal
will be
- emitted. */
+ emitted.]]
}
clear {
- /*@
- @brief Clear all items in the given ctxpopup object.
-
- @ingroup Ctxpopup */
-
+ [[Clear all items in the given ctxpopup object.]]
}
item_append {
- /*@
- @brief Add a new item to a ctxpopup object.
-
- @return A handle to the item added or @c NULL, on errors
+ [[Add a new item to a ctxpopup object.
- @warning Ctxpopup can't hold both an item list and a content at the
same
- time. When an item is added, any previous content will be removed.
- @see elm_object_content_set()
+ Warning:Ctxpopup can't hold both an item list and a content at the
same
+ time. When an item is added, any previous content will be removed.
- @ingroup Ctxpopup */
+ See also \@ref elm_object_content_set.
+ ]]
+ return: Elm_Object_Item *; [[A handle to the item added or $null, on
errors.]]
- return: Elm_Object_Item *;
params {
- @in label: const(char)*; /*@ The Label of the new item */
- @in icon: Evas.Object * @optional; /*@ Icon to be set on new item
*/
- @in func: Evas_Smart_Cb @optional; /*@ Convenience function called
when item selected */
- @in data: const(void)* @optional; /*@ Data passed to @p func */
+ @in label: const(char)*; [[The Label of the new item]]
+ @in icon: Evas.Object * @optional; [[Icon to be set on new item]]
+ @in func: Evas_Smart_Cb @optional; [[Convenience function called
when item selected]]
+ @in data: const(void)* @optional; [[Data passed to $func]]
}
}
item_prepend {
- /*@
- @brief Prepend a new item to a ctxpopup object.
- @since 1.11
-
- @return A handle to the item added or @c NULL, on errors
+ [[Prepend a new item to a ctxpopup object.
- @warning Ctxpopup can't hold both an item list and a content at the
same
- time. When an item is added, any previous content will be removed.
+ Warning: Ctxpopup can't hold both an item list and a content at the
same
+ time. When an item is added, any previous content will be removed.
- @see elm_object_content_set()
+ See also \@ref elm_object_content_set.
- @ingroup Ctxpopup */
+ @since 1.11
+ ]]
+ return: Elm_Object_Item *; [[A handle to the item added or $null, on
errors.]]
- return: Elm_Object_Item *;
params {
- @in label: const(char)*; /*@ The Label of the new item */
- @in icon: Evas.Object * @optional; /*@ Icon to be set on new item
*/
- @in func: Evas_Smart_Cb @optional; /*@ Convenience function called
when item selected */
- @in data: const(void)* @optional; /*@ Data passed to @p func */
+ @in label: const(char)*; [[The Label of the new item]]
+ @in icon: Evas.Object * @optional; [[Icon to be set on new item]]
+ @in func: Evas_Smart_Cb @optional; [[Convenience function called
when item selected]]
+ @in data: const(void)* @optional; [[Data passed to $func]]
}
}
}
diff --git a/src/lib/elm_ctxpopup_item.eo b/src/lib/elm_ctxpopup_item.eo
index e5c324b..abbbe49 100644
--- a/src/lib/elm_ctxpopup_item.eo
+++ b/src/lib/elm_ctxpopup_item.eo
@@ -4,36 +4,30 @@ class Elm.Ctxpopup_Item(Elm.Widget_Item)
methods {
@property prev {
get {
- /*@
- Get the item before @p it in a ctxpopup widget's internal list of
- items.
+ [[Get the item before $ it in a ctxpopup widget's internal list of
+ items.
- @see elm_ctxpopup_item_next_get()
+ See also \@ref elm_ctxpopup_item_next_get.
- @since 1.11
- @ingroup Ctxpopup
- */
+ @since 1.11
+ ]]
}
values {
- item: Elm_Object_Item *; /*@ The item before the object in its
parent's list. If there is no
- previous item for @p it or there's an
error, @c NULL is returned. */
+ item: Elm_Object_Item *; [[The item before the object in its
parent's list. If there is no previous item for $ it or there's an error, $null
is returned.]]
}
}
@property next {
get {
- /*@
- Get the item after @p it in a ctxpopup widget's
- internal list of items.
+ [[Get the item after $ it in a ctxpopup widget's
+ internal list of items.
- @see elm_ctxpopup_item_prev_get()
+ See also \@ref elm_ctxpopup_item_prev_get.
- @since 1.11
- @ingroup Ctxpopup
- */
+ @since 1.11
+ ]]
}
values {
- item: Elm_Object_Item *; /*@ The item after the object in its
parent's list. If there is no
- previous item for @p it or there's an
error, @c NULL is returned. */
+ item: Elm_Object_Item *; [[The item after the object in its
parent's list. If there is no previous item for $ it or there's an error, $null
is returned.]]
}
}
init {
--
