Change internal function to static
[platform/core/uifw/tts.git] / doc / uix_tts_engine_main_doc.h
index 9dade17..eaa5e65 100755 (executable)
 #ifndef __TIZEN_UIX_TTS_ENGINE_DOC_H__
 #define __TIZEN_UIX_TTS_ENGINE_DOC_H__
 
+
 /**
  * @ingroup CAPI_UIX_FRAMEWORK
  * @defgroup CAPI_UIX_TTSE_MODULE TTS Engine
  * @brief The @ref CAPI_UIX_TTSE_MODULE APIs provide functions to operate Text-To-Speech Engine.
- *
- *
  * @section CAPI_UIX_TTSE_MODULE_HEADER Required Header
- *   \#include <ttse.h>
- *
+ * \#include <ttse.h>
  *
  * @section CAPI_UIX_TTSE_MODULE_OVERVIEW Overview
  * Text-To-Speech Engine (below TTSE) is an engine for synthesizing voice from text and playing synthesized sound data.
  * Using the @ref CAPI_UIX_TTSE_MODULE APIs, TTSE developers can provide TTSE service users, who want to apply TTSE, with functions necessary to operate the engine.
  * According to the indispensability of TTSE services, there are two ways to provide them to the users. <br>
- *
  * <b>A. Required TTSE services</b> <br>
  * These services are indispensable to operate TTSE. Therefore, the TTSE developers MUST implement callback functions corresponding to the required TTSE services.
  * The following is a list of the callback functions. <br>
- *
  * <table>
  * <tr>
  * <th>FUNCTION</th>
  * <td>Called when the engine service user checks whether TTS engine needs the application's credential.</td>
  * </tr>
  * </table>
- *
  * The TTSE developers can register the above callback functions at a time with using a structure 'ttse_request_callback_s' and an API 'ttse_main()'.
  * To operate TTSE, the following steps should be used: <br>
  * 1. Create a structure 'ttse_request_callback_s'
  * 2. Implement callback functions. (NOTE that the callback functions should return appropriate values in accordance with the instruction.
- *     If the callback function returns an unstated value, TTS framework will handle it as #TTSE_ERROR_OPERATION_FAILED.) <br>
+ *    If the callback function returns an unstated value, TTS framework will handle it as #TTSE_ERROR_OPERATION_FAILED.) <br>
  * 3. Register callback functions using 'ttse_main()'. (The registered callback functions will be invoked when the TTSE service users request the TTSE services.) <br>
  * 4. Use 'service_app_main()' for working TTSE. <br>
- *
  * <b>B. Optional TTSE services</b> <br>
  * Unlike the required TTSE services, these services are optional to operate TTSE. The followings are optional TTSE services. <br>
  * - receive/provide the private data <br>
- *
  * If the TTSE developers want to provide the above services, use the following APIs and implement the corresponding callback functions: <br>
  * <table>
  * <tr>
  * <td>ttse_private_data_requested_cb()</td>
  * </tr>
  * </table>
- *
  * Using the above APIs, the TTSE developers can register the optional callback functions respectively.
  * (For normal operation, put those APIs before 'service_app_main()' starts.)
- *
  * Unlike callback functions, the following APIs are functions for getting and sending data. The TTSE developers can use these APIs when they implement TTSE services: <br>
  * <table>
  * <tr>
  * </tr>
  * </table>
  *
- *
  * @section CAPI_UIX_TTSE_MODULE_FEATURE Related Features
  * This API is related with the following features:<br>
- *  - http://tizen.org/feature/speech.synthesis<br>
- *
+ * - http://tizen.org/feature/speech.synthesis<br>
  * It is recommended to design feature related codes in your application for reliability.<br>
  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.<br>
  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.<br>
- * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b>.</a>
- *
+ * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
  */
 
+
 #endif /* __TIZEN_UIX_TTS_ENGINE_DOC_H__ */