Init Tizen 2.2.1 tizen_2.2 2.2.1_release submit/tizen_2.2/20131107.111659
authorSehong Na <sehong.na@samsung.com>
Thu, 7 Nov 2013 11:16:45 +0000 (20:16 +0900)
committerSehong Na <sehong.na@samsung.com>
Thu, 7 Nov 2013 11:16:45 +0000 (20:16 +0900)
inc/FUixSpeech.h
inc/FUixSpeechISpeechToTextEventListener.h
inc/FUixSpeechITextToSpeechEventListener.h
inc/FUixSpeechSpeechToText.h
inc/FUixSpeechSpeechToTextTypes.h
inc/FUixSpeechTextToSpeech.h
inc/FUixSpeechTextToSpeechTypes.h
packaging/osp-speech.spec

index cb7b632..bda5cbf 100644 (file)
@@ -19,7 +19,7 @@
  * @file       FUixSpeech.h
  * @brief      This is the header file for the %Speech namespace.
  *
- * This header file contains the declarations and descriptions of the %Tizen::Uix::Speech namespace.
+ * This header file contains the declarations and descriptions of the %Speech namespace.
  */
 
 #ifndef _FUIX_SPEECH_H_
 
 /**
  * @namespace Tizen::Uix::Speech
- * @brief      This namespace contains the classes for the speech and its related functions.
- * @since 2.0
+ * @brief        This namespace contains classes for speech and its related functions.
+ * @since        2.0
  *
- * @remarks    @b Header @b %file: @b \#include @b <FUix.h> @n
- *          @b Library : @b osp-speech-tts, @b osp-speech-stt
+ * @remarks      @b Header @b %file: @b \#include @b <FUix.h> @n
+ *            @b Library: @b osp-speech-tts, @b osp-speech-stt @n
  *
  * The %Speech namespace provides easy and simplified speech recognition and synthesis methods. @n
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/uix/speech_to_text.htm">Speech-To-Text</a> and 
+ * For more information on the %Speech namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/uix/speech_to_text.htm">Speech-To-Text</a> and 
  * <a href="../org.tizen.native.appprogramming/html/guide/uix/text_to_speech.htm">Text-To-Speech</a>.
  *
  * The following diagram illustrates the relationships between the classes belonging to the %Speech namespace.
index ba16097..29228f8 100644 (file)
@@ -33,17 +33,17 @@ namespace Tizen { namespace Uix { namespace Speech
 
 /**
  * @interface   ISpeechToTextEventListener
- * @brief              This interface is a listener for speech recognition events.
+ * @brief              This interface is a listener interface for speech recognition events.
  *
- * @since 2.0
+ * @since              2.0
  *
  * @remarks     @b Header @b %file: @b \#include @b <FUix.h> @n
- *              @b Library : @b osp-speech-stt
+ *              @b Library: @b osp-speech-stt @n
  *
  * The %ISpeechToTextEventListener interface is a listener interface for speech recognition events.
- * It provides methods that are invoked by the voice engine when the status is changed, an
- * error or warning occurs or the result is received in the Speech-To-Text service. @n
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/uix/speech_to_text.htm">Speech-To-Text</a>.
+ * It provides methods that are invoked by the voice engine when the Speech-To-Text service undergoes a status change, returns an
+ * error or warning, or returns a result. @n
+ * For more information on the Speech-To-Text service, see <a href="../org.tizen.native.appprogramming/html/guide/uix/speech_to_text.htm">Speech-To-Text</a>.
  *
  */
 
@@ -82,7 +82,7 @@ public:
      *
      * @since 2.0
      *
-     * @param[in]   error   The reason for an error in the Speech-To-Text service
+     * @param[in]   error   The reason for the error in the Speech-To-Text service
      */
     virtual void OnSpeechToTextErrorOccurred(Tizen::Uix::Speech::SpeechToTextError error) = 0;
 
index e37b15a..abffe9c 100644 (file)
@@ -33,16 +33,17 @@ namespace Tizen { namespace Uix { namespace Speech
 
 /**
  * @interface   ITextToSpeechEventListener
- * @brief       This interface is a listener for the speech synthesis events.
+ * @brief       This interface is a listener interface for speech synthesis events.
  *
  * @since 2.0
  *
  * @remarks     @b Header @b %file: @b \#include @b <FUix.h> @n
- *              @b Library : @b osp-speech-tts
+ *              @b Library: @b osp-speech-tts @n
  *
- * The %ITextToSpeechEventListener interface is a listener interface for the speech synthesis events.
- * It provides methods that are used to notify when the status is changed and an error occurs from the voice engine. @n
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/uix/text_to_speech.htm">Text-To-Speech</a>.
+ * The %ITextToSpeechEventListener interface is a listener interface for speech synthesis events.
+ * It provides methods that are invoked by the voice engine which notifies when the Text-To-Speech service undergoes a status 
+ * change or returns an error. @n
+ * For more information on the Text-To-Speech service, see <a href="../org.tizen.native.appprogramming/html/guide/uix/text_to_speech.htm">Text-To-Speech</a>.
  */
 
 class _OSP_EXPORT_ ITextToSpeechEventListener
@@ -81,7 +82,7 @@ public:
      *
      * @since 2.0
      *
-     * @param[in]   error   The reason for an error in the Text-To-Speech service
+     * @param[in]   error   The reason for the error in the Text-To-Speech service
      */
      virtual void OnTextToSpeechErrorOccurred(Tizen::Uix::Speech::TextToSpeechError error) = 0;
 
index 83dc88b..218a941 100644 (file)
@@ -56,11 +56,10 @@ class _SpeechToTextImpl;
 * @since 2.0
 *
 * @remarks  @b Header @b %file: @b \#include @b <FUix.h> @n
-*           @b Library : @b osp-speech-stt
+*           @b Library: @b osp-speech-stt @n
 *
-* The %SpeechToText class converts spoken words into text.
-* @n
-* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/uix/speech_to_text.htm">Speech-To-Text</a>.
+* The %SpeechToText class converts spoken words into text. @n
+* For more information on the Speech-To-Text service, see <a href="../org.tizen.native.appprogramming/html/guide/uix/speech_to_text.htm">Speech-To-Text</a>.
 *
 * The following example demonstrates how to use the %SpeechToText class. @n
 * In the example, the Start() method is called after invoking the ISpeechToTextEventListener::OnSpeechToTextInitialized() method.
@@ -178,7 +177,7 @@ public:
     /**
      * Initializes this instance of %SpeechToText with the specified @c listener.
      *
-     * @since 2.0
+     * @since          2.0
      *
      * @return      An error code
      * @param[in]   listener        An instance of ISpeechToTextEventListener
@@ -191,24 +190,24 @@ public:
     /**
      * Initializes the Speech-To-Text service. @n
      * The %Initialize() method is asynchronous. @n
-     * The ISpeechToTextEventListener::OnSpeechToTextInitialized() is invoked when the service has been initialized.
-     * @since 2.0
+     * The ISpeechToTextEventListener::OnSpeechToTextInitialized() method is invoked when the service has been initialized.
+     * @since          2.0
      *
-     * @feature           %http://tizen.org/feature/speech.recognition
+     * @feature     %http://tizen.org/feature/speech.recognition
      *
      * @return      An error code
-     * @exception   E_SUCCESS           The method is successful.
-     * @exception  E_UNSUPPORTED_OPERATION   The Emulator or target device does not support the required feature. @b Since: @b 2.1
-     * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
-     * @remarks     
+     * @exception   E_SUCCESS                   The method is successful.
+     * @exception   E_UNSUPPORTED_OPERATION  The Emulator or target device does not support the required feature. @b Since: @b 2.1
+     *                                                                                  For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+     * @remarks
      *                 - Before calling this method, check whether the feature is supported by 
-     *                 Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
-     *                         - This method must be called after Construct().
+        *                        Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+     *                 - This method must be called after the Construct() method.
      */
     result Initialize(void);
 
     /**
-     * Starts recording the speech of a user and converts it to text.
+     * Starts recording the speech of the user and converts it into text.
      *
      * @since 2.0
      *
@@ -217,13 +216,13 @@ public:
      * @exception   E_SYSTEM            A system error has occurred.
      * @exception   E_OUT_OF_MEMORY     The memory is insufficient.
      * @exception   E_SERVICE_BUSY      The recorder is busy.
-     * @exception   E_INVALID_STATE     This instance is not initialized as yet.
-     * @exception   E_INVALID_OPERATION The current status should be @c SPEECH_TO_TEXT_STATUS_READY.
+     * @exception   E_INVALID_STATE     This instance has not been initialized yet.
+     * @exception   E_INVALID_OPERATION The current status is not ::SPEECH_TO_TEXT_STATUS_READY.
      */
     result Start(void);
 
     /**
-     * Stops the recording and current Speech-To-Text service.
+     * Stops the recording and the current Speech-To-Text service.
      *
      * @since 2.0
      *
@@ -231,8 +230,8 @@ public:
      * @exception   E_SUCCESS           The method is successful.
      * @exception   E_SYSTEM            A system error has occurred.
      * @exception   E_OUT_OF_MEMORY     The memory is insufficient.
-     * @exception   E_INVALID_STATE     This instance is not initialized as yet.
-     * @exception   E_INVALID_OPERATION The current status should be @c SPEECH_TO_TEXT_STATUS_RECORDING.
+     * @exception   E_INVALID_STATE     This instance has not been initialized yet.
+     * @exception   E_INVALID_OPERATION The current status is not ::SPEECH_TO_TEXT_STATUS_RECORDING.
      */
     result Stop(void);
 
@@ -244,8 +243,9 @@ public:
      * @return      An error code
      * @exception   E_SUCCESS           The method is successful.
      * @exception   E_SYSTEM            A system error has occurred.
-     * @exception   E_INVALID_STATE     This instance is not initialized as yet.
-     * @exception   E_INVALID_OPERATION The current status should be @c SPEECH_TO_TEXT_STATUS_RECORDING or @c SPEECH_TO_TEXT_STATUS_PROCESSING.
+     * @exception   E_INVALID_STATE     This instance has not been initialized yet.
+     * @exception   E_INVALID_OPERATION The current status is neither ::SPEECH_TO_TEXT_STATUS_RECORDING nor
+        *                                                                      ::SPEECH_TO_TEXT_STATUS_PROCESSING.
      */
     result Cancel(void);
 
@@ -257,8 +257,8 @@ public:
     * @return       An error code
     * @param[in]    locale                  The locale
     * @exception    E_SUCCESS               The method is successful.
-    * @exception    E_UNSUPPORTED_LOCALE    This locale is not supported.
-    * @exception    E_INVALID_STATE         This instance is not initialized as yet.
+    * @exception    E_UNSUPPORTED_LOCALE    The locale is not supported.
+    * @exception    E_INVALID_STATE         This instance has not been initialized yet.
     * @see          GetSupportedLocales()
     */
     result SetLocale(const Tizen::Locales::Locale& locale);
@@ -268,49 +268,49 @@ public:
      *
      * @since 2.0
      *
-     * @return      A current locale
+     * @return      The current locale
      * @exception   E_SUCCESS       The method is successful.
-     * @exception   E_INVALID_STATE This instance is not initialized as yet.
+     * @exception   E_INVALID_STATE This instance has not been initialized yet.
      * @remarks     The specific error code can be accessed using the GetLastResult() method.
      */
     Tizen::Locales::Locale GetLocale(void) const;
 
     /**
-     * Checks whether a locale is supported or not.
+     * Checks if the locale is supported or not.
      *
      * @since 2.0
      *
-     * @return      @c true if the locale is available, @n
+     * @return      @c true if the locale is supported, @n
      *              else @c false
      * @param[in]   locale          The locale
      * @exception   E_SUCCESS       The method is successful.
-     * @exception   E_INVALID_STATE This instance is not initialized as yet.
+     * @exception   E_INVALID_STATE This instance has not been initialized yet.
      * @remarks     The specific error code can be accessed using the GetLastResult() method.
      */
     bool IsLocaleSupported(const Tizen::Locales::Locale& locale) const;
 
     /**
      * Gets the list of supported locales. @n
-     * Each list's item has a pointer of Tizen::Locales::Locale value.
+     * Each list item has a pointer of Tizen::Locales::Locale value.
      *
      * @since 2.0
      *
-     * @return      A list of locales
+     * @return      The list of locales
      * @exception   E_SUCCESS       The method is successful.
-     * @exception   E_INVALID_STATE This instance is not initialized as yet.
+     * @exception   E_INVALID_STATE This instance has not been initialized yet.
      * @remarks     The specific error code can be accessed using the GetLastResult() method.
      */
     const Tizen::Base::Collection::IList* GetSupportedLocales(void) const;
 
     /**
-     * Sets the grammar for %SpeechToText.
+     * Sets the grammar for the Speech-To-Text service.
      *
      * @since 2.0
      *
      * @return      An error code
-     * @param[in]   grammar         A grammar
+     * @param[in]   grammar         The grammar
      * @exception   E_SUCCESS       The method is successful.
-     * @exception   E_INVALID_STATE This instance is not initialized as yet.
+     * @exception   E_INVALID_STATE This instance has not been initialized yet.
      */
     result SetGrammar(SpeechToTextGrammar grammar);
 
@@ -319,47 +319,46 @@ public:
      *
      * @since 2.0
      *
-     * @return      The current grammar used by recognition
+     * @return      The current grammar used for recognition
      * @exception   E_SUCCESS       The method is successful.
-     * @exception   E_INVALID_STATE This instance is not initialized as yet.
+     * @exception   E_INVALID_STATE This instance has not been initialized yet.
      * @remarks     The specific error code can be accessed using the GetLastResult() method.
      */
     SpeechToTextGrammar GetGrammar(void) const;
 
     /**
-     * Sets the silence detection enabled or disabled.
+     * Sets the silence detection feature to enabled or disabled.
      *
      * @since 2.0
      *
      * @return      An error code
-     * @param[in]   enable  Set to @c true to enable the silence detection, @n
-     *                      else @c false
+     * @param[in]   enable             The boolean value that enables or disables the silence detection feature
      * @exception   E_SUCCESS       The method is successful.
-     * @exception   E_INVALID_STATE This instance is not initialized as yet.
+     * @exception   E_INVALID_STATE This instance has not been initialized yet.
      */
     result SetSilenceDetectionEnabled(bool enable);
 
     /**
-     * Checks whether the silence detection feature is enabled.
+     * Checks if the silence detection feature is enabled or not.
      *
      * @since 2.0
      *
-     * @return      @c true if the silence detection is enabled, @n
+     * @return      @c true if the silence detection feature is enabled, @n
      *              else @c false
      * @exception   E_SUCCESS       The method is successful.
-     * @exception   E_INVALID_STATE This instance is not initialized as yet.
+     * @exception   E_INVALID_STATE This instance has not been initialized yet.
      * @remarks     The specific error code can be accessed using the GetLastResult() method.
      */
     bool IsSilenceDetectionEnabled(void) const;
 
     /**
-     * Gets the current status.
+     * Gets the current status of the Speech-To-Text service.
      *
      * @since 2.0
      *
-     * @return      current status
+     * @return      The current status of the Speech-To-Text service
      * @exception   E_SUCCESS           The method is successful.
-     * @exception   E_INVALID_STATE     This instance is not initialized as yet.
+     * @exception   E_INVALID_STATE     This instance has not been initialized yet.
      * @remarks     The specific error code can be accessed using the GetLastResult() method.
      */
     SpeechToTextStatus GetCurrentStatus(void) const;
index e514d98..48e4262 100644 (file)
@@ -17,7 +17,7 @@
 
 /**
  * @file    FUixSpeechSpeechToTextTypes.h
- * @brief   This is the header file for the common data types used by the SpeechToText class.
+ * @brief   This is the header file for the common data types used by the %SpeechToText class.
  *
  * This header file contains the declarations of the common data types and constants used by the SpeechToText class.
  */
@@ -31,7 +31,7 @@ namespace Tizen { namespace Uix { namespace Speech
 /**
 * @enum SpeechToTextStatus
 *
-* Defines the SpeechToText status.
+* Defines the status of the Speech-To-Text service.
 *
 * @since 2.0
 *
@@ -39,7 +39,7 @@ namespace Tizen { namespace Uix { namespace Speech
 */
 enum SpeechToTextStatus
 {
-    SPEECH_TO_TEXT_STATUS_NONE,         /**< The none status */
+    SPEECH_TO_TEXT_STATUS_NONE,         /**< No status */
     SPEECH_TO_TEXT_STATUS_READY,        /**< The ready status */
     SPEECH_TO_TEXT_STATUS_RECORDING,    /**< The recording status */
     SPEECH_TO_TEXT_STATUS_PROCESSING    /**< The recognition processing status */
@@ -48,7 +48,7 @@ enum SpeechToTextStatus
 /**
 * @enum SpeechToTextGrammar
 *
-* Defines the SpeechToText grammar.
+* Defines the grammar of the Speech-To-Text service.
 *
 * @since 2.0
 *
@@ -57,14 +57,15 @@ enum SpeechToTextStatus
 enum SpeechToTextGrammar
 {
     SPEECH_TO_TEXT_GRAMMAR_FREE,        /**< The key is used for general purpose dictation */
-    SPEECH_TO_TEXT_GRAMMAR_WEB_SEARCH   /**< The key is used for recognizing short phrases such as the ones used for %Web search */
+    SPEECH_TO_TEXT_GRAMMAR_WEB_SEARCH  /**< The key is used for recognizing short phrases, 
+       *                                                                               such as the ones used for a web search */
 };
 
 /**
 * @enum SpeechToTextError
 *
-* Defines the errors in SpeechToText. @n
-* When an error occurs, the user can not receive any %SpeechToText result.
+* Defines the errors that occur in the Speech-To-Text service. @n
+* When an error occurs, the user does not receive any Speech-To-Text result.
 *
 * @since 2.0
 *
@@ -72,10 +73,10 @@ enum SpeechToTextGrammar
 */
 enum SpeechToTextError
 {
-    SPEECH_TO_TEXT_ERROR_OUT_OF_MEMORY,         /**< The out of memory error */
+    SPEECH_TO_TEXT_ERROR_OUT_OF_MEMORY,         /**< The out-of-memory error */
     SPEECH_TO_TEXT_ERROR_IO_ERROR,              /**< The I/O error */
     SPEECH_TO_TEXT_ERROR_NETWORK_ERROR,         /**< The network connection error */
-    SPEECH_TO_TEXT_ERROR_TIME_OUT,              /**< The timeout error */
+    SPEECH_TO_TEXT_ERROR_TIME_OUT,              /**< The time-out error */
     SPEECH_TO_TEXT_ERROR_SYSTEM_ERROR,          /**< The system error */
     SPEECH_TO_TEXT_ERROR_UNSUPPORTED_SERVICE    /**< The unsupported service error */
 };
index 7fcb35e..736bf29 100644 (file)
@@ -55,10 +55,10 @@ class _TextToSpeechImpl;
 * @since 2.0
 *
 * @remarks  @b Header @b %file: @b \#include @b <FUix.h> @n
-*           @b Library : @b osp-speech-tts
+*           @b Library: @b osp-speech-tts @n
 *
 * The %TextToSpeech class is used to convert normal language text into speech. @n
-* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/uix/text_to_speech.htm">Text-To-Speech</a>.
+* For more information on the Text-To-Speech service, see <a href="../org.tizen.native.appprogramming/html/guide/uix/text_to_speech.htm">Text-To-Speech</a>.
 *
 * The following example demonstrates how to use the %TextToSpeech class. @n
 * In the example, the Speak() method is called after invoking the ITextToSpeechEventListener::OnTextToSpeechInitialized() method.
@@ -189,48 +189,49 @@ public:
     /**
      * Initializes the Text-To-Speech service. @n
      * The %Initialize() method is asynchronous. @n
-     * The ITextToSpeechEventListener::OnTextToSpeechInitialized() is invoked when the service has been initialized.
+     * The ITextToSpeechEventListener::OnTextToSpeechInitialized() method is invoked when the service has been initialized.
      *
      * @since 2.0
      *
-     * @feature           %http://tizen.org/feature/speech.synthesis
+     * @feature     %http://tizen.org/feature/speech.synthesis
      *
      * @return      An error code
-     * @exception   E_SUCCESS           The method is successful.
-     * @exception  E_UNSUPPORTED_OPERATION   The Emulator or target device does not support the required feature. @b Since: @b 2.1
-     * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
-     * @remarks     
+     * @exception   E_SUCCESS                    The method is successful.
+     * @exception      E_UNSUPPORTED_OPERATION   The Emulator or target device does not support the required feature. @b Since: @b 2.1
+     *                                                                                   For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+     * @remarks
      *                 - Before calling this method, check whether the feature is supported by 
-     *                 Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
-     *                         - This method must be called after Construct().
+        *                        Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+     *                 - This method must be called after the Construct() method.
      */
        result Initialize(void);
 
     /**
-     * Starts the conversion of given text and starts playing the synthesized sound.
+     * Starts the conversion of the given text and plays the synthesized sound.
      *
      * @since 2.0
      *
      * @return      An error code
-     * @param[in]   text            A text string for synthesizing a speech
+     * @param[in]   text            The text string to synthesize the speech
      * @param[in]   requestMode     The request mode
      * @exception   E_SUCCESS       The method is successful.
      * @exception   E_SYSTEM        A system error has occurred.
      * @exception   E_OUT_OF_MEMORY The memory is insufficient.
-     * @exception   E_INVALID_STATE This instance is not initialized as yet.
+     * @exception   E_INVALID_STATE This instance has not been initialized yet.
      */
     result Speak(const Tizen::Base::String& text, TextToSpeechRequestMode requestMode = TEXT_TO_SPEECH_REQUEST_MODE_APPEND);
 
     /**
-     * Stops the synthesis or the sound on playing.
+     * Stops the synthesis of the sound being played.
      *
      * @since 2.0
      *
      * @return      An error code
      * @exception   E_SUCCESS           The method is successful.
      * @exception   E_SYSTEM            A system error has occurred.
-     * @exception   E_INVALID_STATE     This instance is not initialized as yet.
-     * @exception   E_INVALID_OPERATION The current status should be @c TEXT_TO_SPEECH_STATUS_PLAYING or @c TEXT_TO_SPEECH_STATUS_PAUSED.
+     * @exception   E_INVALID_STATE     This instance has not been initialized yet.
+     * @exception   E_INVALID_OPERATION The current status is neither ::TEXT_TO_SPEECH_STATUS_PLAYING nor 
+        *                                                                      ::TEXT_TO_SPEECH_STATUS_PAUSED.
      */
     result Stop(void);
 
@@ -242,8 +243,8 @@ public:
      * @return      An error code
      * @exception   E_SUCCESS           The method is successful.
      * @exception   E_SYSTEM            A system error has occurred.
-     * @exception   E_INVALID_STATE     This instance is not initialized as yet.
-     * @exception   E_INVALID_OPERATION The current status should be @c TEXT_TO_SPEECH_STATUS_PLAYING.
+     * @exception   E_INVALID_STATE     This instance has not been initialized yet.
+     * @exception   E_INVALID_OPERATION The current status is not ::TEXT_TO_SPEECH_STATUS_PLAYING.
      */
     result Pause(void);
 
@@ -255,8 +256,8 @@ public:
      * @return      An error code
      * @exception   E_SUCCESS           The method is successful.
      * @exception   E_SYSTEM            A system error has occurred.
-     * @exception   E_INVALID_STATE     This instance is not initialized as yet.
-     * @exception   E_INVALID_OPERATION The current status should be @c TEXT_TO_SPEECH_STATUS_PAUSED.
+     * @exception   E_INVALID_STATE     This instance has not been initialized yet.
+     * @exception   E_INVALID_OPERATION The current status is not ::TEXT_TO_SPEECH_STATUS_PAUSED.
      */
     result Resume(void);
 
@@ -268,8 +269,8 @@ public:
      * @return      An error code
      * @param[in]   locale                  The current locale
      * @exception   E_SUCCESS               The method is successful.
-     * @exception   E_UNSUPPORTED_LOCALE    This locale is not supported.
-     * @exception   E_INVALID_STATE         This instance is not initialized as yet.
+     * @exception   E_UNSUPPORTED_LOCALE    The locale is not supported.
+     * @exception   E_INVALID_STATE         This instance has not been initialized yet.
      * @see         GetSupportedLocales()
      */
     result SetLocale(const Tizen::Locales::Locale& locale);
@@ -279,36 +280,36 @@ public:
      *
      * @since 2.0
      *
-     * @return      A current locale
+     * @return      The current locale
      * @exception   E_SUCCESS           The method is successful.
-     * @exception   E_INVALID_STATE     This instance is not initialized as yet.
+     * @exception   E_INVALID_STATE     This instance has not been initialized yet.
      * @remarks     The specific error code can be accessed using the GetLastResult() method.
      */
     Tizen::Locales::Locale GetLocale(void) const;
 
     /**
-     * Checks whether a locale is supported.
+     * Checks if the locale is supported or not.
      *
      * @since 2.0
      *
-     * @return      @c true if the locale is available, @n
+     * @return      @c true if the locale is supported, @n
      *              else @c false
      * @param[in]   locale          The locale
      * @exception   E_SUCCESS       The method is successful.
-     * @exception   E_INVALID_STATE This instance is not initialized as yet.
+     * @exception   E_INVALID_STATE This instance has not been initialized yet.
      * @remarks     The specific error code can be accessed using the GetLastResult() method.
      */
     bool IsLocaleSupported(const Tizen::Locales::Locale& locale) const;
 
     /**
      * Gets the list of supported locales. @n
-     * Each list's item has a pointer of Tizen::Locales::Locale value.
+     * Each list item has a pointer of Tizen::Locales::Locale value.
      *
      * @since 2.0
      *
-     * @return      A list of locales
+     * @return      The list of locales
      * @exception   E_SUCCESS           The method is successful.
-     * @exception   E_INVALID_STATE     This instance is not initialized as yet.
+     * @exception   E_INVALID_STATE     This instance has not been initialized yet.
      * @remarks     The specific error code can be accessed using the GetLastResult() method.
      */
     const Tizen::Base::Collection::IList* GetSupportedLocales(void) const;
@@ -319,20 +320,20 @@ public:
      * @since 2.0
      *
      * @return      An error code
-     * @param[in]   rate    A speech rate
+     * @param[in]   rate                       The speech rate
      * @exception   E_SUCCESS           The method is successful.
-     * @exception   E_INVALID_STATE     This instance is not initialized as yet.
+     * @exception   E_INVALID_STATE     This instance has not been initialized yet.
      */
     result SetSpeechRate(TextToSpeechSpeechRate rate);
 
     /**
-     * Gets the current status.
+     * Gets the current status of the Text-To-Speech service.
      *
      * @since 2.0
      *
-     * @return      current status
+     * @return      The current status of the Text-To-Speech service
      * @exception   E_SUCCESS           The method is successful.
-     * @exception   E_INVALID_STATE     TThis instance is not initialized as yet.
+     * @exception   E_INVALID_STATE     This instance has not been initialized yet.
      * @remarks     The specific error code can be accessed using the GetLastResult() method.
      */
     TextToSpeechStatus GetCurrentStatus(void) const;
index af215d4..8ff7428 100644 (file)
@@ -17,7 +17,7 @@
 
 /**
  * @file    FUixSpeechTextToSpeechTypes.h
- * @brief   This is the header file for common data types used by the TextToSpeech class.
+ * @brief   This is the header file for the common data types used by the %TextToSpeech class.
  *
  * This header file contains the declarations of the common data types and constants used by the TextToSpeech class.
  */
@@ -39,14 +39,14 @@ namespace Tizen { namespace Uix { namespace Speech
  */
 enum TextToSpeechRequestMode
 {
-    TEXT_TO_SPEECH_REQUEST_MODE_APPEND,     /**< The new request is added at the queue */
+    TEXT_TO_SPEECH_REQUEST_MODE_APPEND,     /**< A new request is added to the queue */
     TEXT_TO_SPEECH_REQUEST_MODE_REPLACE     /**< All requests in the queue are dropped and replaced by the new request */
 };
 
 /**
  * @enum    TextToSpeechSpeechRate
  *
- * Defines the level of the speech rate.
+ * Defines the speech rate level.
  *
  * @since 2.0
  *
@@ -54,12 +54,12 @@ enum TextToSpeechRequestMode
  */
 enum TextToSpeechSpeechRate
 {
-    TEXT_TO_SPEECH_SPEECH_RATE_SYSTEM_SETTING,  /**< The speech rate from system setting */
-    TEXT_TO_SPEECH_SPEECH_RATE_VERY_SLOW,       /**< The very slow speech rate */
-    TEXT_TO_SPEECH_SPEECH_RATE_SLOW,            /**< The slow speech rate*/
-    TEXT_TO_SPEECH_SPEECH_RATE_NORMAL,          /**< The normal speech rate */
-    TEXT_TO_SPEECH_SPEECH_RATE_FAST,            /**< The fast speech rate */
-    TEXT_TO_SPEECH_SPEECH_RATE_VERY_FAST        /**< The very fast speech rate */
+    TEXT_TO_SPEECH_SPEECH_RATE_SYSTEM_SETTING,  /**< A speech rate from the system setting */
+    TEXT_TO_SPEECH_SPEECH_RATE_VERY_SLOW,       /**< A very slow speech rate */
+    TEXT_TO_SPEECH_SPEECH_RATE_SLOW,            /**< A slow speech rate */
+    TEXT_TO_SPEECH_SPEECH_RATE_NORMAL,          /**< A normal speech rate */
+    TEXT_TO_SPEECH_SPEECH_RATE_FAST,            /**< A fast speech rate */
+    TEXT_TO_SPEECH_SPEECH_RATE_VERY_FAST        /**< A very fast speech rate */
 };
 
 /**
@@ -73,11 +73,11 @@ enum TextToSpeechSpeechRate
  */
 enum TextToSpeechStatus
 {
-    TEXT_TO_SPEECH_STATUS_NONE,         /**< The none status */
+    TEXT_TO_SPEECH_STATUS_NONE,         /**< No status */
     TEXT_TO_SPEECH_STATUS_READY,        /**< The ready status */
     TEXT_TO_SPEECH_STATUS_SYNTHESIZING, /**< The synthesizing status */
     TEXT_TO_SPEECH_STATUS_PLAYING,      /**< The playing status */
-    TEXT_TO_SPEECH_STATUS_PAUSED        /**< The paused status*/
+    TEXT_TO_SPEECH_STATUS_PAUSED        /**< The paused status */
 };
 
 /**
@@ -91,10 +91,10 @@ enum TextToSpeechStatus
  */
 enum TextToSpeechError
 {
-    TEXT_TO_SPEECH_ERROR_OUT_OF_MEMORY,         /**< The out of memory error */
+    TEXT_TO_SPEECH_ERROR_OUT_OF_MEMORY,         /**< The out-of-memory error */
     TEXT_TO_SPEECH_ERROR_IO_ERROR,              /**< The I/O error */
     TEXT_TO_SPEECH_ERROR_NETWORK_ERROR,         /**< The network connection error */
-    TEXT_TO_SPEECH_ERROR_TIME_OUT,              /**< The timeout error */
+    TEXT_TO_SPEECH_ERROR_TIME_OUT,              /**< The time-out error */
     TEXT_TO_SPEECH_ERROR_SYSTEM_ERROR,          /**< The system error */
     TEXT_TO_SPEECH_ERROR_UNSUPPORTED_SERVICE    /**< The unsupported service error */
 };
index a535245..73a87ba 100644 (file)
@@ -1,8 +1,9 @@
+%define debug_package %{nil}
 %define __strip /bin/true
 
 Name:          osp-speech
 Summary:       osp speech library
-Version:       1.2.1.0
+Version:       1.2.2.0
 Release:       2
 Group:         System/Libraries
 License:       TO_BE/FILLED_IN
@@ -47,11 +48,22 @@ osp speech library (DEV)
 %setup -q
 
 %build 
+%if 0%{?tizen_build_binary_release_type_eng}
+CXXFLAGS="$CXXFLAGS -D_SECURE_LOG"
+%endif
 MAJORVER=`echo %{version} | awk 'BEGIN {FS="."}{print $1}'`
 %ifarch %{ix86}
-CXXFLAGS="$CXXFLAGS -D_OSP_DEBUG_ -D_SECURE_LOG -D_OSP_X86_ -D_OSP_EMUL_" cmake . -DCMAKE_INSTALL_PREFIX=%{_prefix} -DFULLVER=%{version} -DMAJORVER=${MAJORVER}
+%if 0%{?simulator}
+CXXFLAGS="$CXXFLAGS -D_OSP_DEBUG_ -D_OSP_X86_ -D_OSP_EMUL_" cmake . -DCMAKE_INSTALL_PREFIX=%{_prefix} -DFULLVER=%{version} -DMAJORVER=${MAJORVER}
+%else
+CXXFLAGS="$CXXFLAGS -D_OSP_DEBUG_ -D_OSP_X86_ " cmake . -DCMAKE_INSTALL_PREFIX=%{_prefix} -DFULLVER=%{version} -DMAJORVER=${MAJORVER}
+%endif
 %else
+%if 0%{?tizen_build_binary_release_type_eng}
 CXXFLAGS="-O2 -g -pipe -Wall -fno-exceptions -Wformat -Wformat-security -Wl,--as-needed -fmessage-length=0 -march=armv7-a -mtune=cortex-a8 -mlittle-endian -mfpu=neon -mfloat-abi=softfp -D__SOFTFP__ -mthumb -Wa,-mimplicit-it=thumb -funwind-tables -D_OSP_DEBUG_ -D_SECURE_LOG -D_OSP_ARMEL_" cmake . -DCMAKE_INSTALL_PREFIX=%{_prefix} -DFULLVER=%{version} -DMAJORVER=${MAJORVER}
+%else
+CXXFLAGS="-O2 -g -pipe -Wall -fno-exceptions -Wformat -Wformat-security -Wl,--as-needed -fmessage-length=0 -march=armv7-a -mtune=cortex-a8 -mlittle-endian -mfpu=neon -mfloat-abi=softfp -D__SOFTFP__ -mthumb -Wa,-mimplicit-it=thumb -funwind-tables -D_OSP_DEBUG_ -D_OSP_ARMEL_" cmake . -DCMAKE_INSTALL_PREFIX=%{_prefix} -DFULLVER=%{version} -DMAJORVER=${MAJORVER}
+%endif
 %endif
 
 # Call make instruction with smp support