[atspi] add description of elm_atspi_bridge_utils_say

Change-Id: Ic771f12cfac445e258388d65debc1a86c657c339

diff --git a/src/lib/elm_atspi_bridge.h b/src/lib/elm_atspi_bridge.h
index 22dcf34..41556d2 100644 (file)
--- a/src/lib/elm_atspi_bridge.h
+++ b/src/lib/elm_atspi_bridge.h
@@ -1,6 +1,23 @@
 #include "elm_atspi_bridge.eo.h"
 //TIZEN_ONLY(20160527) - Add direct reading feature
 typedef void (*Elm_Atspi_Say_Signal_Cb)(void *data, const char *say_signal);
+/**
+ * @brief Reads given text by screen reader
+ *
+ * @param text The text to read
+ * @param discardable If TRUE, reading can be discarded by subsequent reading requests,
+ * if FALSE the reading must finish before next reading request can be started
+ * @param func the callback function that is called on reading signals emitted
+ * during processing of this reading request. Elm_Atspi_Say_Signal_Cb callback
+ * type specifies two parameters (void *data, const char *signal), where data
+ * is a user data and signal can be one of the following signals:
+ * “ReadingCancelled”
+ * “ReadingStopped”
+ * “ReadingSkipped”
+ * @param data The user data to be passed to the callback function
+ *
+ * @ingoup Elm_Atspi_Bridge
+ */
 EAPI void elm_atspi_bridge_utils_say(const char* text,
                                      Eina_Bool discardable,
                                      const Elm_Atspi_Say_Signal_Cb func,