docs: atspi: document atspi bridge class
authorStefan Schmidt <stefan@osg.samsung.com>
Fri, 21 Oct 2016 21:05:52 +0000 (23:05 +0200)
committerStefan Schmidt <stefan@osg.samsung.com>
Fri, 21 Oct 2016 22:22:07 +0000 (00:22 +0200)
src/lib/elementary/elm_atspi_bridge.eo

index 404dfcf..b1e05f8 100644 (file)
@@ -1,5 +1,6 @@
 class Elm.Atspi.Bridge (Efl.Object)
 {
+   [[ATSPI bridge class]]
    legacy_prefix: elm_atspi_bridge;
    eo_prefix: elm_obj_atspi_bridge;
    event_prefix: elm_atspi_bridge;
@@ -8,7 +9,7 @@ class Elm.Atspi.Bridge (Efl.Object)
          get {
             [[Indicate if connection with AT-SPI2 bus has been established.]]
             values {
-               ret: bool;
+               ret: bool; [[$true if connection has been established, $false otherwise]]
             }
          }
       }
@@ -18,7 +19,7 @@ class Elm.Atspi.Bridge (Efl.Object)
       Efl.Object.destructor;
    }
    events {
-      connected;
-      disconnected;
+      connected; [[Connected with AT-SPI2 bus]]
+      disconnected; [[Disconnected from AT-SPI2 bus]]
    }
 }