Apply reviewed doxygen comments.

Change-Id: I7b56a747d3887f43de3d6c3ea97bd99867324a6d
Signed-off-by: Bum-Sung Cho <bs0111.cho@samsung.com>

diff --git a/inc/FUiIme.h b/inc/FUiIme.h
index 19d98a9..dfb9597 100644 (file)
--- a/inc/FUiIme.h
+++ b/inc/FUiIme.h
@@ -17,9 +17,9 @@
 \r
 /**\r
  * @file FUiIme.h\r
- * @brief This is the header file for the %Tizen::Ui::Ime namespace.\r
+ * @brief This is the header file for the %Ime namespace.\r
  *\r
- * This header file contains the declarations and descriptions of the %Tizen::Ui::Ime namespace.\r
+ * This header file contains the declarations and descriptions of the %Ime namespace.\r
  */\r
 \r
 #ifndef _FUI_IME_H_\r
@@ -41,9 +41,9 @@
  * @remarks @b Header @b %file: @b \#include @b <FUiIme.h> @n\r
  * @b Library : @b osp-ime\r
  *\r
- * The %Ui::Ime namespace provides a way to input a language in the associated text input UI control.\r
+ * The %Ime namespace provides a way to input a language in the associated text input UI control.\r
  *\r
- * For more information on the %Ui::Ime namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/input.htm">Input Guide</a>.\r
+ * For more information on the %Ime namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/input.htm">Input Guide</a>.\r
  *\r
  * The following diagram illustrates the relationships between the classes belonging to the %Ime namespace.\r
  *\r

diff --git a/inc/FUiImeIInputMethodProvider.h b/inc/FUiImeIInputMethodProvider.h
index 0335a43..b64eac5 100644 (file)
--- a/inc/FUiImeIInputMethodProvider.h
+++ b/inc/FUiImeIInputMethodProvider.h
@@ -105,7 +105,7 @@ public:
        * @privlevel partner
        * @privilege %http://tizen.org/privilege/ime
        *
-       * @return A style of the input panel
+       * @return The style of the input panel
        */
        virtual Tizen::Ui::InputPanelStyle GetInputPanelStyle(void)
        {
@@ -113,13 +113,13 @@ public:
        }
 
        /**
-       * Called when the associated text input UI control requests the language of the input method.
+       * Called when an associated text input UI control requests the language of the input method.
        *
        * @since 2.1
        * @privlevel partner
        * @privilege %http://tizen.org/privilege/ime
        *
-       * @return A language of the input method
+       * @return The language of the input method
        */
        virtual Tizen::Locales::Locale GetLanguage(void)
        {

diff --git a/inc/FUiImeInputMethod.h b/inc/FUiImeInputMethod.h
index 5e7b9ad..e7374c0 100644 (file)
--- a/inc/FUiImeInputMethod.h
+++ b/inc/FUiImeInputMethod.h
@@ -120,7 +120,7 @@ public:
 
        /**
        * Sets an instance of IInputMethodProvider. @n
-       * The %InputMethod instance accepts only one provider. So users must unregister the provider by setting the specified @c pProvider as @c null before deallocating
+       * The %InputMethod instance accepts only one provider. So users must unregister the provider by setting @c pProvider as @c null before deallocating
        * an instance of the provider.
        *
        * @since 2.1
@@ -138,7 +138,7 @@ public:
 
        /**
        * Sets an instance of IInputMethodProviderF. @n
-       * The %InputMethod instance accepts only one provider. So users must unregister the provider by setting the specified @c pProvider as @c null before deallocating
+       * The %InputMethod instance accepts only one provider. So users must unregister the provider by setting @c pProvider as @c null before deallocating
        * an instance of the provider.
        *
        * @since 2.1
@@ -156,7 +156,7 @@ public:
 
        /**
        * Sets an instance of IInputMethodListener. @n
-       * The %InputMethod instance accepts only one listener. So users must unregister the listener by setting the specified @c pListener as @c null before deallocating an
+       * The %InputMethod instance accepts only one listener. So users must unregister the listener by setting @c pListener as @c null before deallocating an
        * instance of the listener.
        *
        * @since 2.1
@@ -181,7 +181,7 @@ public:
        * @param[in] cursorOffset The offset value from the cursor position
        * @param[in] length The length of the text to delete
        * @exception E_SUCCESS The method is successful.
-       * @exception E_INVALID_ARG The specified @c length is less than or equal to @c 0.
+       * @exception E_INVALID_ARG The @c length is less than or equal to @c 0.
        * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
        */
        result DeleteText(int cursorOffset, int length);

diff --git a/inc/FUiImeInputMethodInfo.h b/inc/FUiImeInputMethodInfo.h
index 28f2446..07dd636 100644 (file)
--- a/inc/FUiImeInputMethodInfo.h
+++ b/inc/FUiImeInputMethodInfo.h
@@ -108,7 +108,7 @@ public:
         * @privlevel platform\r
         * @privilege %http://tizen.org/privilege/imemanager\r
         *\r
-        * @return The type\r
+        * @return The type of an input method\r
         * @exception E_SUCCESS The method is successful.\r
         * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
         */\r