atspi: enhance documentation

 ┌────────────────────────────────────────────────┐
 │commit ebc57884d8f6fe908824b5cf350b86be56587678 │
 │Author: Shinwoo Kim <cinoo.kim@samsung.com>     │
 │Date:   Thu Apr 20 10:00:44 2017 +0900          │
 │                                                │
 │ atspi: enhance documentation                   │
 └────────────────────────────────────────────────┘

Change-Id: I02b651427088abbf6f650d7d70cecefebfebd040

diff --git a/elm_intro.h.in b/elm_intro.h.in
index 7394aaa..62a8d22 100644 (file)
--- a/elm_intro.h.in
+++ b/elm_intro.h.in
@@ -1,5 +1,28 @@
 /**
- * @page elementary_main
+ * @defgroup Elementary Elementary
+ * @ingroup EFL
+ *
+ * @brief Elementary provide a VERY SIMPLE Toolkit.
+ *
+ * See @ref Elementary for more details.
+ *
+ * @defgroup elm_infra_group Elementary Infrastructure
+ * @ingroup Elementary
+ * @brief This contains infrastructure modules that facilitate the use of widgets.
+ *
+ * @defgroup elm_accessibility_group Accessibility
+ * @ingroup elm_infra_group
+ *
+ * @defgroup elm_container_group Elementary Containers
+ * @ingroup Elementary
+ * @brief Elementary is about displaying its widgets in a nice layout, for this
+ *        purpose it provides a number of containers.
+ *
+ * @defgroup elm_widget_group Elementary Widgets
+ * @ingroup Elementary
+ * @brief This contains basic elementary widgets.
+ *
+ * @page Elementary
  * @image html  elementary.png
  * @version @VMAJ@.@VMIN@.@VMIC@
  * @date 2008-2014

diff --git a/src/lib/elementary/efl_access_legacy.h b/src/lib/elementary/efl_access_legacy.h
index e96308f..03a9fe1 100644 (file)
--- a/src/lib/elementary/efl_access_legacy.h
+++ b/src/lib/elementary/efl_access_legacy.h
@@ -1,3 +1,9 @@
+/**
+ * @defgroup Elm_Interface_Atspi_Accessible Atspi Accessible
+ * @ingroup elm_accessibility_group
+ * @{
+ */
+
 typedef Eo Elm_Interface_Atspi_Accessible;
 
 enum _Elm_Atspi_Role
@@ -790,3 +796,7 @@ EAPI void elm_atspi_accessible_relationships_clear(Elm_Interface_Atspi_Accessibl
 EAPI void elm_atspi_accessible_state_notify(Elm_Interface_Atspi_Accessible *obj, Elm_Atspi_State_Set state_types_mask, Eina_Bool recursive);
 
 #include "efl_access.eo.legacy.h"
+
+/**
+ * @}
+ */

diff --git a/src/lib/elementary/elm_access.h b/src/lib/elementary/elm_access.h
index 429c447..7936aa4 100644 (file)
--- a/src/lib/elementary/elm_access.h
+++ b/src/lib/elementary/elm_access.h
@@ -1,12 +1,6 @@
 /**
- * @defgroup Access Access
- * @ingroup Elementary
- *
- * WARNING! this API is not finalized. It is unstable. - do not use it if
- * you want no breaks in future.
- *
- * TODO: description
- *
+ * @defgroup Elm_Access Access
+ * @ingroup elm_accessibility_group
  */
 
 enum _Elm_Access_Info_Type

diff --git a/src/lib/elementary/elm_atspi_bridge.eo b/src/lib/elementary/elm_atspi_bridge.eo
index e068426..97018e1 100644 (file)
--- a/src/lib/elementary/elm_atspi_bridge.eo
+++ b/src/lib/elementary/elm_atspi_bridge.eo
@@ -7,7 +7,10 @@ class Elm.Atspi.Bridge (Efl.Object)
    methods {
       @property connected {
          get {
-            [[Indicate if connection with AT-SPI2 bus has been established.]]
+            [[Indicate if connection with AT-SPI2 bus has been established.
+
+              \@internal
+            ]]
             values {
                ret: bool; [[$true if connection has been established, $false otherwise]]
             }

diff --git a/src/lib/elementary/elm_atspi_bridge.h b/src/lib/elementary/elm_atspi_bridge.h
index edcca86..ecb2412 100644 (file)
--- a/src/lib/elementary/elm_atspi_bridge.h
+++ b/src/lib/elementary/elm_atspi_bridge.h
@@ -6,7 +6,19 @@
 #include "elm_atspi_bridge.eo.legacy.h"
 #endif
 #endif
+/**
+ * @defgroup Elm_Atspi_Bridge Atspi Bridge
+ * @ingroup elm_accessibility_group
+ */
 //TIZEN_ONLY(20160527) - Add direct reading feature
+/**
+ * This callback type is used to provide reading status information.
+ * @param data The data specified as the last param when setting this callback
+ * @param say_signal The signal decribes reading status information
+ * @see elm_atspi_bridge_utils_say
+ * @ingroup Elm_Atspi_Bridge
+ * @if MOBILE @since_tizen 4.0 @elseif WEARABLE @since_tizen 3.0 @endif
+ */
 typedef void (*Elm_Atspi_Say_Signal_Cb)(void *data, const char *say_signal);
 /**
  * @brief Reads given text by screen reader
@@ -23,7 +35,7 @@ typedef void (*Elm_Atspi_Say_Signal_Cb)(void *data, const char *say_signal);
  * “ReadingSkipped”
  * @param data The user data to be passed to the callback function
  *
- * @ingoup Elm_Atspi_Bridge
+ * @ingroup Elm_Atspi_Bridge
  *
  * @if WEARABLE @since_tizen 3.0
  * @endif
@@ -34,8 +46,9 @@ EAPI void elm_atspi_bridge_utils_say(const char* text,
                                      const void *data);
 //
 //TIZEN_ONLY(20161027) - Export elm_atspi_bridge_utils_is_screen_reader_enabled
-/** Determines if screen reader is enabled
- *
+/**
+ * @internal
+ * Determines if screen reader is enabled
  * @ingroup Elm_Atspi_Bridge
  */
 EAPI Eina_Bool elm_atspi_bridge_utils_is_screen_reader_enabled(void);

diff --git a/src/lib/elementary/elm_interfaces.h b/src/lib/elementary/elm_interfaces.h
index 6c5b317..12e2ff7 100644 (file)
--- a/src/lib/elementary/elm_interfaces.h
+++ b/src/lib/elementary/elm_interfaces.h
@@ -27,7 +27,15 @@
 //#ifdef EFL_BETA_API_SUPPORT
 //
 #include "efl_access_action.eo.legacy.h"
+/**
+ * @defgroup Elm_Interface_Atspi_Component Atspi Component
+ * @ingroup elm_accessibility_group
+ * @{
+ */
 #include "efl_access_component.eo.legacy.h"
+/**
+ * @}
+ */
 #include "efl_access_editable_text.eo.legacy.h"
 #include "efl_access_image.eo.legacy.h"
 #include "efl_access_selection.eo.legacy.h"

diff --git a/src/lib/elementary/elm_object.h b/src/lib/elementary/elm_object.h
index d91f7ec..d8b5c3c 100644 (file)
--- a/src/lib/elementary/elm_object.h
+++ b/src/lib/elementary/elm_object.h
@@ -199,7 +199,7 @@ EAPI const char *elm_object_access_info_get(Evas_Object *obj);
  * @param obj The object
  * @param part The object's part name to register
  *
- * @ingroup General
+ * @ingroup Elm_General
  *
  * @if WEARABLE @since_tizen 3.0
  * @endif