q66 pushed a commit to branch master.
http://git.enlightenment.org/core/elementary.git/commit/?id=0882c1ecb61bebb100c567d254de50b2585eee1f
commit 0882c1ecb61bebb100c567d254de50b2585eee1f
Author: Vivek Ellur <vivek.el...@samsung.com>
Date: Wed Jul 29 14:44:07 2015 +0100
elm_flipselector: convert docs of elm_flipselector.eo to new format
Summary:
Changed docs of elm_flipselector.eo and elm_flipselector_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/D2884
---
src/lib/elm_flipselector.eo | 221 ++++++++++++++++-----------------------
src/lib/elm_flipselector_item.eo | 59 ++++-------
2 files changed, 113 insertions(+), 167 deletions(-)
diff --git a/src/lib/elm_flipselector.eo b/src/lib/elm_flipselector.eo
index 00598ed..4260e3f 100644
--- a/src/lib/elm_flipselector.eo
+++ b/src/lib/elm_flipselector.eo
@@ -5,190 +5,153 @@ class Elm.Flipselector (Elm.Layout,
Elm_Interface_Atspi_Widget_Action,
methods {
@property first_interval {
set {
- /*@
- Set the interval on time updates for a user mouse button hold
- on a flip selector widget.
+ [[Set the interval on time updates for a user mouse button hold
+ on a flip selector widget.
- This interval value is @b decreased while the user holds the
- mouse pointer either flipping up or flipping down a given flip
- selector.
+ This interval value is decreased while the user holds the
+ mouse pointer either flipping up or flipping down a given flip
+ selector.
- This helps the user to get to a given item distant from the
- current one easier/faster, as it will start to flip quicker and
- quicker on mouse button holds.
+ This helps the user to get to a given item distant from the
+ current one easier/faster, as it will start to flip quicker and
+ quicker on mouse button holds.
- The calculation for the next flip interval value, starting from
- the one set with this call, is the previous interval divided by
- 1.05, so it decreases a little bit.
+ The calculation for the next flip interval value, starting from
+ the one set with this call, is the previous interval divided by
+ 1.05, so it decreases a little bit.
- The default starting interval value for automatic flips is
- @b 0.85 seconds.
+ The default starting interval value for automatic flips is
+ 0.85 seconds.
- @see elm_flipselector_first_interval_get()
-
- @ingroup Flipselector */
+ See also @.first_interval.get.
+ ]]
}
get {
- /*@
- Get the interval on time updates for an user mouse button hold
- on a flip selector widget.
-
- @return The (first) interval value, in seconds, set on it
-
- @see elm_flipselector_first_interval_set() for more details
+ [[Get the interval on time updates for an user mouse button hold
+ on a flip selector widget.
- @ingroup Flipselector */
+ See also @.first_interval.set for more details.
+ ]]
}
values {
- interval: double; /*@ The (first) interval value in seconds */
+ interval: double; [[The (first) interval value in seconds.]]
}
}
@property items {
get {
- /*@
- Get the internal list of items in a given flip selector widget.
-
- @return The list of items (#Elm_Object_Item as data) or
- @c NULL on errors.
-
- 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(),
- elm_flipselector_item_selected_get(),
- elm_flipselector_item_selected_set().
-
- @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.
-
- @ingroup Flipselector */
+ [[Get the internal list of items in a given flip selector widget.
+
+ 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,
+ \@ref elm_flipselector_item_selected_get,
+ \@ref elm_flipselector_item_selected_set.
+
+ 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.
+ ]]
return: const(list<Elm.Object.Item*>)*;
}
}
@property first_item {
get {
- /*@
- Get the first item in the given flip selector widget's list of
- items.
-
- @return The first item or @c NULL, if it has no items (and on
- errors)
+ [[Get the first item in the given flip selector widget's list of
+ items.
- @see elm_flipselector_item_append()
- @see elm_flipselector_last_item_get()
+ See also @.item_append,
+ @.last_item.get.
+ ]]
+ return: Elm_Object_Item *; [[The first item or $null, if it has no
items (and on
+ errors).]]
- @ingroup Flipselector */
- return: Elm_Object_Item *;
}
}
@property last_item {
get {
- /*@
- Get the last item in the given flip selector widget's list of
- items.
+ [[Get the last item in the given flip selector 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.
+ ]]
+ return: Elm_Object_Item *; [[The last item or $null, if it has no
items (and on
+ errors).]]
- @see elm_flipselector_item_prepend()
- @see elm_flipselector_first_item_get()
-
- @ingroup Flipselector */
- return: Elm_Object_Item *;
}
}
@property selected_item {
get {
- /*@
- Get the currently selected item in a flip selector widget.
-
- @return The selected item or @c NULL, if the widget has no items
- (and on errors)
+ [[Get the currently selected item in a flip selector widget.]]
+ return: Elm_Object_Item *; [[The selected item or $null, if the
widget has no items
+ (and on errors).]]
- @ingroup Flipselector */
- return: Elm_Object_Item *;
}
}
item_prepend {
- /*@
- Prepend a (text) item to a flip selector widget
+ [[Prepend a (text) item to a flip selector widget
- @return A handle to the item added or @c NULL, on errors
+ The widget's list of labels to show will be prepended with the
+ given value. If the user wishes so, a callback function pointer
+ can be passed, which will get called when this same item is
+ selected.
- The widget's list of labels to show will be prepended with the
- given value. If the user wishes so, a callback function pointer
- can be passed, which will get called when this same item is
- selected.
-
- @note The current selection @b won't be modified by prepending
- an element to the list.
-
- @note The maximum length of the text label is going to be
- determined <b>by the widget's theme</b>. Strings larger than
- that value are going to be @b truncated.
-
- @ingroup Flipselector */
+ Note: The current selection won't be modified by prepending
+ an element to the list.
+ Note: The maximum length of the text label is going to be
+ determined by the widget's theme. Strings larger than
+ that value are going to be truncated.
+ ]]
return: Elm_Object_Item *;
params {
- @in label: const(char)*; /*@ The (text) label of the new item */
- @in func: Evas_Smart_Cb @optional; /*@ Convenience callback
function to take place when
- item is selected */
- @in data: void * @optional; /*@ Data passed to @p func, above */
+ @in label: const(char)*; [[The (text) label of the new item.]]
+ @in func: Evas_Smart_Cb @optional; [[Convenience callback function
to take place when
+ item is selected.]]
+ @in data: void * @optional; [[Data passed to $func, above.]]
}
}
flip_next {
- /*@
- Programmatically select the next item of a flip selector widget
-
- @note The selection will be animated. Also, if it reaches the
- end of its list of member items, it will continue with the first
- one onwards.
-
- @ingroup Flipselector */
+ [[Programmatically select the next item of a flip selector widget
+ Note: The selection will be animated. Also, if it reaches the
+ end of its list of member items, it will continue with the first
+ one onwards.
+ ]]
}
item_append {
- /*@
- Append a (text) item to a flip selector widget
+ [[Append a (text) item to a flip selector widget
- @return A handle to the item added or @c NULL, on errors
+ The widget's list of labels to show will be appended with the
+ given value. If the user wishes so, a callback function pointer
+ can be passed, which will get called when this same item is
+ selected.
- The widget's list of labels to show will be appended with the
- given value. If the user wishes so, a callback function pointer
- can be passed, which will get called when this same item is
- selected.
-
- @note The current selection @b won't be modified by appending an
- element to the list.
-
- @note The maximum length of the text label is going to be
- determined <b>by the widget's theme</b>. Strings larger than
- that value are going to be @b truncated.
-
- @ingroup Flipselector */
+ Note: The current selection won't be modified by appending an
+ element to the list.
+ Note: The maximum length of the text label is going to be
+ determined by the widget's theme. Strings larger than
+ that value are going to be truncated.
+ ]]
return: Elm_Object_Item *;
params {
- @in label: const(char)*; /*@ The (text) label of the new item */
- @in func: Evas_Smart_Cb @optional; /*@ Convenience callback
function to take place when
- item is selected */
- @in data: const(void)* @optional; /*@ Data passed to @p func,
above */
+ @in label: const(char)*; [[The (text) label of the new item.]]
+ @in func: Evas_Smart_Cb @optional; [[Convenience callback function
to take place when
+ item is selected.]]
+ @in data: const(void)* @optional; [[Data passed to $func, above.]]
}
}
flip_prev {
- /*@
- Programmatically select the previous item of a flip selector
- widget
-
- @note The selection will be animated. Also, if it reaches the
- beginning of its list of member items, it will continue with the
- last one backwards.
-
- @ingroup Flipselector */
+ [[Programmatically select the previous item of a flip selector
+ widget
+ Note: The selection will be animated. Also, if it reaches the
+ beginning of its list of member items, it will continue with the
+ last one backwards.
+ ]]
}
}
implements {
diff --git a/src/lib/elm_flipselector_item.eo b/src/lib/elm_flipselector_item.eo
index 4566bd4..3628460 100644
--- a/src/lib/elm_flipselector_item.eo
+++ b/src/lib/elm_flipselector_item.eo
@@ -4,61 +4,44 @@ class Elm.Flipselector_Item(Elm.Widget_Item)
methods {
@property selected {
get {
- /*@
- Get whether a given flip selector widget's item is the
currently
+ [[Get whether a given flip selector widget's item is the
currently
selected one.
- @see elm_flipselector_item_selected_set()
- @ingroup Flipselector
- */
+ See also @.selected.set.
+ ]]
}
set {
- /*@
- Set whether a given flip selector widget's item should be the
+ [[Set whether a given flip selector widget's item should be the
currently selected one.
- This sets whether @p item is or not the selected (thus, under
- display) one. If @p item is different than the one under
display,
- the latter will be unselected. If the @p item is set to be
- unselected, on the other hand, the @b first item in the
widget's
+ This sets whether $item is or not the selected (thus, under
+ display) one. If $item is different than the one under
display,
+ the latter will be unselected. If the $item is set to be
+ unselected, on the other hand, the first item in the widget's
internal members list will be the new selected one.
- @see elm_flipselector_item_selected_get()
-
- @ingroup Flipselector
- */
+ See also @.selected.get.
+ ]]
}
values {
- selected: bool; /*@ EINA_TRUE if selected EINA_FALSE
otherwise */
+ selected: bool; [[$true if selected, $false otherwise.]]
}
}
prev_get @const {
- /*@
- Get the item before @p item in a flip selector widget's internal
list of
- items.
-
- @return The item before the @p item, in its parent's list. If
there is no
- previous item for @p item or there's an error, @c NULL is
returned.
-
- @see elm_flipselector_item_next_get()
+ [[Get the item before $item in a flip selector widget's internal
list of
+ items.
- @ingroup Flipselector
- */
- return: Elm_Object_Item *;
+ See also @.next_get.
+ ]]
+ return: Elm_Object_Item *; [[The item before the $item, in its
parent's list. If there is no previous item for $item or there's an error,
$null is returned.]]
}
next_get @const {
- /*@
- Get the item after @p item in a flip selector widget's
- internal list of items.
-
- @return The item after the @p item, in its parent's list. If
there is no next
- item for @p item or there's an error, @c NULL is returned.
-
- @see elm_flipselector_item_prev_get()
+ [[Get the item after $item in a flip selector widget's
+ internal list of items.
- @ingroup Flipselector
- */
- return: Elm_Object_Item *;
+ See also @.prev_get.
+ ]]
+ return: Elm_Object_Item *; [[The item after the $item, in its
parent's list. If there is no next item for $item or there's an error, $null is
returned.]]
}
}
implements {
--
