atspi_action: improve existing documentation
authorStefan Schmidt <stefan@osg.samsung.com>
Thu, 30 Jun 2016 15:31:10 +0000 (17:31 +0200)
committerStefan Schmidt <stefan@osg.samsung.com>
Thu, 30 Jun 2016 16:15:44 +0000 (18:15 +0200)
Fix typos, add parameter descriptions and consolidate property describtions.

src/lib/elementary/elm_interface_atspi_action.eo

index fb74388..aca4c70 100644 (file)
@@ -1,36 +1,36 @@
 mixin Elm.Interface.Atspi_Action ()
 {
+   [[ATSPI action mixin]]
    eo_prefix: elm_interface_atspi_action;
    data: null;
    methods {
       @property name @protected @virtual_pure {
+         [[Gets action name for given id]]
          get {
-            [[Gets action name for given id]]
          }
          values {
-            name: string;
+            name: string; [[Action name]]
          }
          keys {
             id: int;
          }
       }
       @property localized_name @protected {
+         [[Gets localized action name for given id]]
          get {
-            [[Gets localized action name for given id]]
          }
          values {
-            name: string;
+            name: string; [[Localized name]]
          }
          keys {
             id: int;
          }
       }
       @property description @protected @virtual_pure {
+         [[Action description for given id]]
          get {
-            [[Gets action description for given id]]
          }
          set {
-            [[Sets action description for given id]]
             return: bool;
          }
          values {
@@ -41,8 +41,8 @@ mixin Elm.Interface.Atspi_Action ()
          }
       }
       @property actions @protected {
+         [[Get list of available widget actions]]
          get @virtual_pure {
-            [[Get list of available widget actions]]
          }
          values {
             actions: list<Elm_Atspi_Action>; [[contains statically allocated strings]]