stefan pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=c322b65aa0e009b6cc81bad0917ea24a76317790
commit c322b65aa0e009b6cc81bad0917ea24a76317790 Author: Stefan Schmidt <[email protected]> Date: Thu Nov 24 11:50:22 2016 +0100 docs: elm: fill gaps in prefs, radio, route, slider and spinner eo file docs --- src/lib/elementary/elm_prefs.eo | 18 +++++++++--------- src/lib/elementary/elm_radio.eo | 4 ++-- src/lib/elementary/elm_route.eo | 6 +++--- src/lib/elementary/elm_slider.eo | 18 +++++++++--------- src/lib/elementary/elm_spinner.eo | 9 +++++---- 5 files changed, 28 insertions(+), 27 deletions(-) diff --git a/src/lib/elementary/elm_prefs.eo b/src/lib/elementary/elm_prefs.eo index 9ea1986..a6a0d69 100644 --- a/src/lib/elementary/elm_prefs.eo +++ b/src/lib/elementary/elm_prefs.eo @@ -5,6 +5,7 @@ type Elm_Prefs_Reset_Mode: __undefined_type; [[Elementary preferences reset mode class Elm.Prefs (Elm.Widget, Efl.File) { + [[Elementary preferences class]] legacy_prefix: elm_prefs; eo_prefix: elm_obj_prefs; event_prefix: elm_prefs; @@ -150,7 +151,7 @@ class Elm.Prefs (Elm.Widget, Efl.File) return: bool; [[$true, on success, $false otherwise]] params { - @in name: string; [[the name of the SWALLOW item (as declared in the prefs collection)]] + @in name: string; [[The name of the SWALLOW item (as declared in the prefs collection)]] @in child: Efl.Canvas.Object; [[The object to occupy the item]] } } @@ -184,7 +185,7 @@ class Elm.Prefs (Elm.Widget, Efl.File) return: Efl.Canvas.Object; [[The unswallowed object, or NULL on errors]] params { - @in name: string; [[the name of the SWALLOW item (as declared in the prefs collection)]] + @in name: string; [[The name of the SWALLOW item (as declared in the prefs collection)]] } } item_visible_set { @@ -221,12 +222,11 @@ class Elm.Prefs (Elm.Widget, Efl.File) Elm.Widget.focus_next; } events { - page,changed; [[s]] - page,saved; [[s]] - page,reset; [[s]] - page,loaded; [[s]] - item,changed; [[s]] - action; [[ss]] + page,changed; [[Called when page changed]] + page,saved; [[Called when page was saved]] + page,reset; [[Called when page was reset]] + page,loaded; [[Called when page got loaded]] + item,changed; [[Called when item changed]] + action; [[Called when action was done]] } - } diff --git a/src/lib/elementary/elm_radio.eo b/src/lib/elementary/elm_radio.eo index 44f36da..bc79bbb 100644 --- a/src/lib/elementary/elm_radio.eo +++ b/src/lib/elementary/elm_radio.eo @@ -1,5 +1,6 @@ class Elm.Radio (Elm.Check, Elm.Interface.Atspi_Widget_Action) { + [[Elementary radio class]] legacy_prefix: elm_radio; eo_prefix: elm_obj_radio; event_prefix: elm_radio; @@ -88,7 +89,6 @@ class Elm.Radio (Elm.Check, Elm.Interface.Atspi_Widget_Action) Elm.Interface.Atspi_Widget_Action.elm_actions.get; } events { - changed; + changed; [[Called when radio changed]] } - } diff --git a/src/lib/elementary/elm_route.eo b/src/lib/elementary/elm_route.eo index a29ef9b..ad2d553 100644 --- a/src/lib/elementary/elm_route.eo +++ b/src/lib/elementary/elm_route.eo @@ -1,14 +1,15 @@ class Elm.Route (Elm.Widget) { + [[Elementary route class]] legacy_prefix: elm_route; eo_prefix: elm_obj_route; methods { @property emap { set { - [[No description supplied by the EAPI.]] + [[Set map widget for this route]] } values { - emap: void_ptr; + emap: void_ptr; [[Elementary map widget]] } } @property longitude_min_max { @@ -45,5 +46,4 @@ class Elm.Route (Elm.Widget) Efl.Canvas.Group.group_del; Elm.Widget.theme_apply; } - } diff --git a/src/lib/elementary/elm_slider.eo b/src/lib/elementary/elm_slider.eo index 14f25f7..7394a25 100644 --- a/src/lib/elementary/elm_slider.eo +++ b/src/lib/elementary/elm_slider.eo @@ -6,6 +6,7 @@ class Elm.Slider (Elm.Layout, Efl.Ui.Progress, Elm.Interface.Atspi.Value, Elm.Interface.Atspi_Widget_Action) { + [[Elementary slider class]] legacy_prefix: elm_slider; eo_prefix: elm_obj_slider; event_prefix: elm_slider; @@ -96,7 +97,7 @@ class Elm.Slider (Elm.Layout, Efl.Ui.Progress, [[Get whether the indicator of the slider is set or not.]] } values { - flag: bool; + flag: bool; [[$true if indicator is shown on focus, $false otherwise]] } } @property step { @@ -152,7 +153,7 @@ class Elm.Slider (Elm.Layout, Efl.Ui.Progress, set { } get { } values { - enable: bool; + enable: bool; [[$true if two indicators are enabled, $false otherwise]] } } @property range { @@ -163,8 +164,8 @@ class Elm.Slider (Elm.Layout, Efl.Ui.Progress, set { } get { } values { - from: double; [[range minimum value]] - to: double; [[range maximum value]] + from: double; [[Range minimum value]] + to: double; [[Range maximum value]] } } } @@ -194,10 +195,9 @@ class Elm.Slider (Elm.Layout, Efl.Ui.Progress, Elm.Interface.Atspi_Widget_Action.elm_actions.get; } events { - changed; - delay,changed; - slider,drag,start; - slider,drag,stop; + changed; [[Called when slider changed]] + delay,changed; [[Called when delay changed]] + slider,drag,start; [[Called when slider drag started]] + slider,drag,stop; [[Called when slider drag stopped]] } - } diff --git a/src/lib/elementary/elm_spinner.eo b/src/lib/elementary/elm_spinner.eo index 265002a..e39a704 100644 --- a/src/lib/elementary/elm_spinner.eo +++ b/src/lib/elementary/elm_spinner.eo @@ -1,6 +1,7 @@ class Elm.Spinner (Elm.Layout, Efl.Ui.Spin, Elm.Interface.Atspi.Value, Elm.Interface.Atspi_Widget_Action) { + [[Elementary spinner class]] legacy_prefix: elm_spinner; eo_prefix: elm_obj_spinner; event_prefix: elm_spinner; @@ -168,9 +169,9 @@ class Elm.Spinner (Elm.Layout, Efl.Ui.Spin, Elm.Interface.Atspi_Widget_Action.elm_actions.get; } events { - changed; - delay,changed; - spinner,drag,start; - spinner,drag,stop; + changed; [[Called when spinner changed]] + delay,changed; [[Called when spinner delay changed]] + spinner,drag,start; [[Called when spinner drag started]] + spinner,drag,stop; [[Called when spinner drag stopped]] } } --
