From: Shinwoo Kim <cinoo.kim@samsung.com>
Date: Fri, 17 Mar 2017 07:56:19 +0000 (+0900)
Subject: atspi: enhance atspi accessible documentation
X-Git-Tag: accepted/tizen/common/20170331.152656~10
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=f59019aa18cb8ae2f3f4e55aba888ac67b3d3e09;p=platform%2Fupstream%2Felementary.git

atspi: enhance atspi accessible documentation

Change-Id: I2b31efa84d996f91016c6821f588100252606461
---

diff --git a/src/lib/elm_interface_atspi_accessible.eo b/src/lib/elm_interface_atspi_accessible.eo
index 15db266..77ddf12 100644
--- a/src/lib/elm_interface_atspi_accessible.eo
+++ b/src/lib/elm_interface_atspi_accessible.eo
@@ -20,15 +20,15 @@ mixin Elm_Interface_Atspi_Accessible ()
    methods {
       @property localized_role_name @protected {
          get {
-            [[Gets an localized string describing ATSPI widget role name.]]
+            [[Gets an localized string describing accessible object role name.]]
          }
          values {
-            localized_name: const(char)*;
+            localized_name: const(char)*; [[Localized accessible role name]]
          }
       }
       @property name {
          get {
-            [[Gets an string describing ATSPI widget role name.  Should be free by a user.
+            [[Gets an accessible name of the object.
 
               \@if MOBILE \@since_tizen 2.4
               \@elseif WEARABLE \@since_tizen 3.0
@@ -36,14 +36,15 @@ mixin Elm_Interface_Atspi_Accessible ()
             ]]
          }
          set {
-            [[
+            [[Sets an accessible name of the object.
+
               \@if MOBILE \@since_tizen 2.4
               \@elseif WEARABLE \@since_tizen 3.0
               \@endif
             ]]
          }
          values {
-            name: const(char)*; [[obj name]]
+            name: const(char)*; [[Accessible name]]
          }
       }
       //TIZEN_ONLY(20190922): add name callback, description callback.
@@ -59,15 +60,15 @@ mixin Elm_Interface_Atspi_Accessible ()
       //
       @property relation_set @protected {
          get {
-            [[Gets an string describing ATSPI widget role name. Lists and elements Should be free by a user.]]
+            [[Gets an all relations between accessible object and other accessible objects.]]
          }
          values {
-            relations: Elm_Atspi_Relation_Set;
+            relations: Elm_Atspi_Relation_Set; [[Accessible relation set]]
          }
       }
       @property role {
          get {
-            [[Gets the role of the widget in ATSPI Accessibility domain.
+            [[Gets the role of the object in accessibility domain.
 
               \@if MOBILE \@since_tizen 2.4
               \@elseif WEARABLE \@since_tizen 3.0
@@ -75,19 +76,20 @@ mixin Elm_Interface_Atspi_Accessible ()
             ]]
          }
          set {
-            [[
+            [[Sets the role of the object in accessibility domain.
+
               \@if MOBILE \@since_tizen 2.4
               \@elseif WEARABLE \@since_tizen 3.0
               \@endif
             ]]
          }
          values {
-            role: Elm_Atspi_Role;
+            role: Elm_Atspi_Role; [[Accessible role]]
          }
       }
       @property children @protected {
          get {
-            [[Gets widget's accessible children.]]
+            [[Gets object's accessible children.]]
          }
          values {
             children: free(own(list<Elm_Interface_Atspi_Accessible *> *), eina_list_free);
@@ -98,15 +100,15 @@ mixin Elm_Interface_Atspi_Accessible ()
             [[Gets human-readable string indentifying widget accessibility role.]]
          }
          values {
-            role_name: const(char)*;
+            role_name: const(char)*; [[Accessible role name]]
          }
       }
       @property attributes @protected {
          get {
-            [[Gets key-value pairs identifying widget extra attributes. Must be free by a user.]]
+            [[Gets key-value pairs identifying object extra attributes. Must be free by a user.]]
          }
          values {
-            attributes: free(own(list<own(Elm_Atspi_Attribute *)> *), elm_atspi_attributes_list_free);
+            attributes: free(own(list<own(Elm_Atspi_Attribute *)> *), elm_atspi_attributes_list_free); [[List of object attributes]]
          }
       }
       //TIZEN_ONLY(20160729): attributes_get, append, reading_information set APIs added/updated.
@@ -140,12 +142,12 @@ mixin Elm_Interface_Atspi_Accessible ()
             [[Gets index of the child in parent's children list.]]
          }
          values {
-            idx: int;
+            idx: int; [[Index in children list]]
          }
       }
       @property description {
          get {
-            [[Gets widget contextual information.
+            [[Gets contextual information about object.
 
               \@if MOBILE \@since_tizen 2.4
               \@elseif WEARABLE \@since_tizen 3.0
@@ -153,7 +155,7 @@ mixin Elm_Interface_Atspi_Accessible ()
             ]]
          }
          set {
-            [[Sets contextual information about widget.
+            [[Sets widget contextual information.
 
               \@if MOBILE \@since_tizen 2.4
               \@elseif WEARABLE \@since_tizen 3.0
@@ -161,7 +163,7 @@ mixin Elm_Interface_Atspi_Accessible ()
             ]]
          }
          values {
-            description: const(char)*;
+            description: const(char)*; [[Accessible contextual information]]
          }
       }
       //TIZEN_ONLY(20190922): add name callback, description callback.
@@ -177,10 +179,10 @@ mixin Elm_Interface_Atspi_Accessible ()
       //
       @property parent @protected {
          get {
-            [[Gets widget accessible parent.]]
+            [[Gets object's accessible parent.]]
          }
          set {
-            [[Sets widget accessible parent.]]
+            [[Sets object's accessible parent.]]
          }
          values {
             parent: Elm_Interface_Atspi_Accessible *;
@@ -188,7 +190,7 @@ mixin Elm_Interface_Atspi_Accessible ()
       }
       @property state_set @protected {
          get {
-            [[Gets set describing widget accessible states.]]
+            [[Gets set describing object accessible states.]]
          }
          values {
             states: Elm_Atspi_State_Set;