Modified the description related to floating mode

Change-Id: I974c2417089d20e89b0db6cebc53c54550bc36af

diff --git a/include/inputmethod.h b/include/inputmethod.h
index 4a863779812885df0da08c86b168c35b7da202ce..11b51f3fd4d186ec92d3984eb173947bc0a39e59 100644 (file)
--- a/include/inputmethod.h
+++ b/include/inputmethod.h
@@ -2264,7 +2264,7 @@ int ime_send_private_command(const char *command);
 int ime_commit_content(const char *content, const char *description, const char *mime_type);
 
 /**
- * @brief Request to set floating mode or not.
+ * @brief Sets the floating mode or not.
  *
  * @since_tizen 4.0
  *
@@ -2272,7 +2272,7 @@ int ime_commit_content(const char *content, const char *description, const char
  *
  * @privilege %http://tizen.org/privilege/ime
  *
- * @param[in] floating_mode Floating mode or not
+ * @param[in] floating_mode @c true - floating mode on, @c false - floating mode off
  *
  * @return 0 on success, otherwise a negative error value
  * @retval #IME_ERROR_NONE No error
@@ -2285,7 +2285,7 @@ int ime_commit_content(const char *content, const char *description, const char
 int ime_set_floating_mode(bool floating_mode);
 
 /**
- * @brief Request to allow the floating input panel window to move along with the mouse pointer when the mouse is pressed.
+ * @brief Allows the floating input panel window to move along with the mouse pointer when the mouse is pressed.
  *
  * @since_tizen 4.0
  *
@@ -2293,21 +2293,24 @@ int ime_set_floating_mode(bool floating_mode);
  *
  * @privilege %http://tizen.org/privilege/ime
  *
- * @remarks This function can be used in floating mode.
+ * @remarks This function can be used in floating mode. If the floating mode is deactivated, calling this function has no effect.
  *
  * @return 0 on success, otherwise a negative error value
  * @retval #IME_ERROR_NONE No error
  * @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
  * @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
  *
+ * @pre The floating mode was turned on with ime_set_floating_mode().
+ *
  * @see ime_set_floating_mode()
  * @see ime_set_floating_drag_end()
  */
 int ime_set_floating_drag_start(void);
 
 /**
- * @brief Request to stop moving floating input panel window.
- * This function must be called after invoking ime_set_floating_drag_start().
+ * @brief Disallows the movement of the floating input panel window with the mouse pointer when the mouse is pressed.
+ *
+ * @details This function must be called after invoking ime_set_floating_drag_start(). Otherwise the call is ignored.
  *
  * @since_tizen 4.0
  *
@@ -2315,13 +2318,16 @@ int ime_set_floating_drag_start(void);
  *
  * @privilege %http://tizen.org/privilege/ime
  *
- * @remarks This function can be used in floating mode.
+ * @remarks This function can be used in floating mode. If the floating mode is deactivated, calling this function has no effect.
  *
  * @return 0 on success, otherwise a negative error value
  * @retval #IME_ERROR_NONE No error
  * @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
  * @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
  *
+ * @pre The floating mode was turned on with ime_set_floating_mode().
+ * @pre ime_set_floating_drag_start() was called before.
+ *
  * @see ime_set_floating_mode()
  * @see ime_set_floating_drag_start()
  */