From 77b436736990c413d21f2d7bae1a67da32b30e6e Mon Sep 17 00:00:00 2001 From: Vivek Ellur Date: Thu, 16 Jul 2015 15:13:27 +0100 Subject: [PATCH] elm_button: Converted docs of elm_button eo to new format Summary: Changed the docs of elm_bubble.eo and elm_button.eo to the new format Signed-off-by: Vivek Ellur Reviewers: q66 Reviewed By: q66 Differential Revision: https://phab.enlightenment.org/D2827 --- src/lib/elm_bubble.eo | 24 ++++++--------- src/lib/elm_button.eo | 81 +++++++++++++++++++++------------------------------ 2 files changed, 43 insertions(+), 62 deletions(-) diff --git a/src/lib/elm_bubble.eo b/src/lib/elm_bubble.eo index 94a1812..a98c07d 100644 --- a/src/lib/elm_bubble.eo +++ b/src/lib/elm_bubble.eo @@ -18,28 +18,22 @@ class Elm.Bubble (Elm.Layout, Evas.Clickable_Interface) methods { @property pos { set { - /*@ - Set the corner of the bubble + [[Set the corner of the bubble - This function sets the corner of the bubble. The corner will be used to - determine where the arrow in the frame points to and where label, icon and - info are shown. + This function sets the corner of the bubble. The corner will be used to + determine where the arrow in the frame points to and where label, icon and + info are shown. - - @ingroup Bubble */ + ]] } get { - /*@ - Get the corner of the bubble - - @return The given corner for the bubble. - - This function gets the selected corner of the bubble. + [[Get the corner of the bubble - @ingroup Bubble */ + This function gets the selected corner of the bubble. + ]] } values { - pos: Elm.Bubble.Pos; /*@ The given corner for the bubble. */ + pos: Elm.Bubble.Pos; [[The given corner for the bubble.]] } } } diff --git a/src/lib/elm_button.eo b/src/lib/elm_button.eo index cd09409..ad58c37 100644 --- a/src/lib/elm_button.eo +++ b/src/lib/elm_button.eo @@ -5,90 +5,77 @@ class Elm.Button (Elm.Layout, Evas.Clickable_Interface, methods { @property autorepeat_initial_timeout { set { - /*@ - Set the initial timeout before the autorepeat event is generated + [[Set the initial timeout before the autorepeat event is generated - Sets the timeout, in seconds, since the button is pressed until the - first @c repeated signal is emitted. If @p t is 0.0 or less, there - won't be any delay and the event will be fired the moment the button is - pressed. + Sets the timeout, in seconds, since the button is pressed until the + first $repeated signal is emitted. If $t is 0.0 or less, there + won't be any delay and the event will be fired the moment the button is + pressed. - @see elm_button_autorepeat_set() - @see elm_button_autorepeat_gap_timeout_set() + See also @.autorepeat.set, + @.autorepeat_gap_timeout.set. - @ingroup Button */ + ]] } get { - /*@ - Get the initial timeout before the autorepeat event is generated + [[Get the initial timeout before the autorepeat event is generated - @return Timeout in seconds + See also @.autorepeat_initial_timeout.set. - @see elm_button_autorepeat_initial_timeout_set() - - @ingroup Button */ + ]] } values { - t: double; /*@ Timeout in seconds */ + t: double; [[Timeout in seconds]] } } @property autorepeat_gap_timeout { set { - /*@ - Set the interval between each generated autorepeat event + [[Set the interval between each generated autorepeat event - After the first @c repeated event is fired, all subsequent ones will - follow after a delay of @p t seconds for each. + After the first $repeated event is fired, all subsequent ones will + follow after a delay of $t seconds for each. - @see elm_button_autorepeat_initial_timeout_set() + See also @.autorepeat_initial_timeout.set. - @ingroup Button */ + ]] } get { - /*@ - Get the interval between each generated autorepeat event - - @return Interval in seconds - - @ingroup Button */ + [[Get the interval between each generated autorepeat event]] } values { - t: double; /*@ Interval in seconds */ + t: double; [[Interval in seconds]] } } @property autorepeat { set { - /*@ - Turn on/off the autorepeat event generated when the button is kept pressed + [[Turn on/off the autorepeat event generated when the button is kept pressed - When off, no autorepeat is performed and buttons emit a normal @c clicked - signal when they are clicked. + When off, no autorepeat is performed and buttons emit a normal $clicked + signal when they are clicked. - When on, keeping a button pressed will continuously emit a @c repeated - signal until the button is released. The time it takes until it starts - emitting the signal is given by - elm_button_autorepeat_initial_timeout_set(), and the time between each - new emission by elm_button_autorepeat_gap_timeout_set(). + When on, keeping a button pressed will continuously emit a $repeated + signal until the button is released. The time it takes until it starts + emitting the signal is given by + @.autorepeat_initial_timeout.set, and the time between each + new emission by @.autorepeat_gap_timeout.set. - @ingroup Button */ + ]] } get { - /*@ - Get whether the autorepeat feature is enabled - - @return @c EINA_TRUE if autorepeat is on, @c EINA_FALSE otherwise + [[Get whether the autorepeat feature is enabled + ($true if autorepeat is on, $false otherwise) - @see elm_button_autorepeat_set() + See also @.autorepeat.set. - @ingroup Button */ + ]] } values { - on: bool; /*@ A bool to turn on/off the event */ + on: bool; [[A bool to turn on/off the event]] } } @property admits_autorepeat { get { - /*@ Get whether the button supports autorepeat. */ + [[Get whether the button supports autorepeat.]] legacy: null; } values { -- 2.7.4