a11y: enhance documentation 04/189904/1
authorShinwoo Kim <cinoo.kim@samsung.com>
Fri, 21 Sep 2018 11:30:34 +0000 (20:30 +0900)
committerShinwoo Kim <cinoo.kim@samsung.com>
Fri, 21 Sep 2018 11:36:37 +0000 (20:36 +0900)
For unexposed following API
 - elm_atspi_attributes_list_free
 - elm_atspi_relation_clone
 - elm_atspi_relation_free
 - elm_atspi_relation_set_clone
 - elm_atspi_relation_set_free
 - elm_atspi_relation_set_relation_append
 - elm_atspi_relation_set_relation_remove
 - elm_atspi_relation_set_relation_type_remove
 - elm_atspi_text_text_attribute_free
 - elm_atspi_bridge_connected_get
 - elm_access_object_register
 - elm_access_object_unregister
 - elm_access_object_get

Change-Id: I1c20596243b319544a14983a48976055e7ac4186

src/lib/elm_access.h
src/lib/elm_atspi_bridge.eo
src/lib/elm_interface_atspi_accessible.h
src/lib/elm_interface_atspi_text.h

index 162d429..0635711 100644 (file)
@@ -111,7 +111,7 @@ typedef void (*Elm_Access_Activate_Cb)(void *data, Evas_Object *part_obj, Elm_Ob
  * @param parent The elementary object which is used for creating
  * accessible object
  *
- * @ingroup Access
+ * @ingroup Elm_Access
  *
  * @if MOBILE @since_tizen 4.0
  * @elseif WEARABLE @since_tizen 3.0
@@ -125,7 +125,7 @@ EAPI Evas_Object *elm_access_object_register(Evas_Object *obj, Evas_Object *pare
  *
  * @param obj The Evas object to unregister accessible object
  *
- * @ingroup Access
+ * @ingroup Elm_Access
  *
  * @if MOBILE @since_tizen 4.0
  * @elseif WEARABLE @since_tizen 3.0
@@ -140,7 +140,7 @@ EAPI void elm_access_object_unregister(Evas_Object *obj);
  * @param obj The evas object
  * @return Accessible object of the evas object or NULL for any error
  *
- * @ingroup Access
+ * @ingroup Elm_Access
  *
  * @if MOBILE @since_tizen 4.0
  * @elseif WEARABLE @since_tizen 3.0
index a0c6171..522eb0c 100644 (file)
@@ -6,7 +6,6 @@ class Elm.Atspi_Bridge (Eo.Base)
          get {
             [[Indicate if connection with AT-SPI2 bus has been established.
 
-              \@internal
               \@if MOBILE \@since_tizen 3.0
               \@elseif WEARABLE \@since_tizen 3.0
               \@endif
index d4a6bb3..e721ff6 100644 (file)
@@ -425,7 +425,6 @@ typedef enum _Elm_Atspi_Move_Outed_Type Elm_Atspi_Move_Outed_Type;
 
 
 /**
- * @internal
  * Free Elm_Atspi_Attributes_List
  *
  * @if MOBILE @since_tizen 3.0
@@ -437,7 +436,6 @@ EAPI void elm_atspi_attributes_list_free(Eina_List *list);
 typedef Eina_List *Elm_Atspi_Relation_Set;
 
 /**
- * @internal
  * Frees relation.
  *
  * @if MOBILE @since_tizen 3.0
@@ -447,7 +445,6 @@ typedef Eina_List *Elm_Atspi_Relation_Set;
 EAPI void elm_atspi_relation_free(Elm_Atspi_Relation *relation);
 
 /**
- * @internal
  * Clones relation.
  *
  * @if MOBILE @since_tizen 3.0
@@ -457,7 +454,6 @@ EAPI void elm_atspi_relation_free(Elm_Atspi_Relation *relation);
 EAPI Elm_Atspi_Relation * elm_atspi_relation_clone(const Elm_Atspi_Relation *relation);
 
 /**
- * @internal
  * Appends relation to relation set
  *
  * @if MOBILE @since_tizen 3.0
@@ -467,7 +463,6 @@ EAPI Elm_Atspi_Relation * elm_atspi_relation_clone(const Elm_Atspi_Relation *rel
 EAPI Eina_Bool elm_atspi_relation_set_relation_append(Elm_Atspi_Relation_Set *set, Elm_Atspi_Relation_Type type, const Eo *rel_obj);
 
 /**
- * @internal
  * Removes relation from relation set
  *
  * @if MOBILE @since_tizen 3.0
@@ -477,7 +472,6 @@ EAPI Eina_Bool elm_atspi_relation_set_relation_append(Elm_Atspi_Relation_Set *se
 EAPI void elm_atspi_relation_set_relation_remove(Elm_Atspi_Relation_Set *set, Elm_Atspi_Relation_Type type, const Eo *rel_obj);
 
 /**
- * @internal
  * Removes all relation from relation set of a given type
  *
  * @if MOBILE @since_tizen 3.0
@@ -487,7 +481,6 @@ EAPI void elm_atspi_relation_set_relation_remove(Elm_Atspi_Relation_Set *set, El
 EAPI void elm_atspi_relation_set_relation_type_remove(Elm_Atspi_Relation_Set *set, Elm_Atspi_Relation_Type type);
 
 /**
- * @internal
  * Frees Elm_Atspi_Relation_Set
  *
  * @if MOBILE @since_tizen 3.0
@@ -497,7 +490,6 @@ EAPI void elm_atspi_relation_set_relation_type_remove(Elm_Atspi_Relation_Set *se
 EAPI void elm_atspi_relation_set_free(Elm_Atspi_Relation_Set *set);
 
 /**
- * @internal
  * Clones Elm_Atspi_Relation_Set
  *
  * @if MOBILE @since_tizen 3.0
index e1febd0..833f6cc 100644 (file)
@@ -1,6 +1,12 @@
 #ifndef ELM_INTERFACE_ATSPI_TEXT_H
 #define ELM_INTERFACE_ATSPI_TEXT_H
 
+/**
+ * @defgroup Elm_Interface_Atspi_Text Atspi Text
+ * @ingroup elm_accessibility_group
+ * @{
+ */
+
 enum _Elm_Atspi_Text_Granulatity
 {
    ELM_ATSPI_TEXT_GRANULARITY_CHAR,
@@ -65,4 +71,8 @@ struct _Elm_Atspi_Text_Change_Info
 #include "elm_interface_atspi_text.eo.legacy.h"
 #endif
 
+/**
+ * @}
+ */
+
 #endif