stefan pushed a commit to branch master.

http://git.enlightenment.org/core/efl.git/commit/?id=b2026d0e3898b33787c7dc1e96a0a4525ce54854

commit b2026d0e3898b33787c7dc1e96a0a4525ce54854
Author: Stefan Schmidt <ste...@osg.samsung.com>
Date:   Fri Apr 29 10:40:54 2016 +0200

    docs: elm_check: fully document the check widget
---
 src/lib/elementary/elm_check.eo | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)

diff --git a/src/lib/elementary/elm_check.eo b/src/lib/elementary/elm_check.eo
index 7df41b3..40c6fdc 100644
--- a/src/lib/elementary/elm_check.eo
+++ b/src/lib/elementary/elm_check.eo
@@ -1,16 +1,22 @@
 class Elm.Check (Elm.Nstate, Elm.Interface_Atspi_Widget_Action)
 {
+   [[Check widget
+
+   The check widget allows for toggling a value between true and false.
+   Check objects are a lot like radio objects in layout and functionality,
+   except they do not work as a group, but independently, and only toggle
+   the value of a boolean between false and true.
+   ]]
    eo_prefix: efl_ui_check;
    methods {
       @property selected {
+         [[The on/off state of the check object.]]
          set {
-            [[Set the on/off state of the check object.]]
          }
          get {
-            [[Get the state of the check object.]]
          }
          values {
-            value: bool;
+            value: bool; [[$true if the check object is selected, $false 
otherwise]]
          }
       }
    }
@@ -29,7 +35,7 @@ class Elm.Check (Elm.Nstate, 
Elm.Interface_Atspi_Widget_Action)
       Elm.Interface_Atspi_Widget_Action.elm_actions.get;
    }
    events {
-      changed;
+      changed; [[This is called whenever the user changes the state of the 
check
+                  objects (event_info is always NULL).]]
    }
-
 }

-- 


Reply via email to