efl-util.h added detail comments and fix TYPO

Change-Id: I0eb613f428e227496bd2146c5b9b777af77e2a49

diff --git a/include/efl_util.h b/include/efl_util.h
index 2568825..2ff226d 100644 (file)
--- a/include/efl_util.h
+++ b/include/efl_util.h
@@ -51,7 +51,7 @@ typedef enum
    EFL_UTIL_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
    EFL_UTIL_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
    EFL_UTIL_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
-   EFL_UTIL_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permisson denied */
+   EFL_UTIL_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
    EFL_UTIL_ERROR_NO_SUCH_DEVICE = TIZEN_ERROR_NO_SUCH_DEVICE, /**< @platform No such device or address (@b Since: 2.4) */
    EFL_UTIL_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< @platform Function not implemented (@b Since: 2.4) */
    EFL_UTIL_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< @platform Not supported (@b Since: 2.4) */
@@ -98,7 +98,7 @@ typedef enum
  * @retval #EFL_UTIL_ERROR_NONE Successful
  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE Window type not supported
- * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Unprevilige access
+ * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied
  */
 API int efl_util_set_notification_window_level(Evas_Object *window, efl_util_notification_level_e level);
 
@@ -117,7 +117,7 @@ API int efl_util_set_notification_window_level(Evas_Object *window, efl_util_not
 API int efl_util_get_notification_window_level(Evas_Object *window, efl_util_notification_level_e *level);
 
 /**
- * @deprecated Deprecated since_tizen 3.0
+ * @deprecated Deprecated since_tizen 3.0.
  * @brief Called when an error occurs for setting notification window level
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @param[in] window The EFL window
@@ -129,10 +129,10 @@ API int efl_util_get_notification_window_level(Evas_Object *window, efl_util_not
 typedef void (*efl_util_notification_window_level_error_cb)(Evas_Object *window, int error_code, void *user_data);
 
 /**
- * @deprecated Deprecated since_tizen 3.0
+ * @deprecated Deprecated since_tizen 3.0.
  * @brief Registers a callback function to be invoked when an error which set the notification level occurs.
- * @details An application can check error by the return value of efl_util_set_notification_window_level.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @remarks An application can check error by the return value of efl_util_set_notification_window_level.
  * @param[in] window The EFL window
  * @param[in] callback The callback function to register
  * @param[in] user_data The user data to be passed to the callback function
@@ -147,10 +147,10 @@ typedef void (*efl_util_notification_window_level_error_cb)(Evas_Object *window,
 API int efl_util_set_notification_window_level_error_cb(Evas_Object *window, efl_util_notification_window_level_error_cb callback, void *user_data);
 
 /**
- * @deprecated Deprecated since_tizen 3.0
+ * @deprecated Deprecated since_tizen 3.0.
  * @brief Unregisters the callback function.
- * @details An application can check error by the return value of efl_util_set_notification_window_level.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @remarks An application can check error by the return value of efl_util_set_notification_window_level.
  * @param[in] window The EFL window
  * @return @c 0 on success, otherwise a negative error value
  * @retval #EFL_UTIL_ERROR_NONE Successful
@@ -192,7 +192,7 @@ API int efl_util_set_window_opaque_state(Evas_Object *window, int opaque);
  * @return @c 0 on success, otherwise a negative error value
  * @retval #EFL_UTIL_ERROR_NONE Successful
  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Unprevilige access
+ * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied
  */
 API int efl_util_set_window_screen_mode(Evas_Object *window, efl_util_screen_mode_e mode);
 
@@ -208,7 +208,7 @@ API int efl_util_set_window_screen_mode(Evas_Object *window, efl_util_screen_mod
 API int efl_util_get_window_screen_mode(Evas_Object *window, efl_util_screen_mode_e *mode);
 
 /**
- * @deprecated Deprecated since_tizen 3.0
+ * @deprecated Deprecated since_tizen 3.0.
  * @brief Called when an error occurs for setting window's screen mode
  * @since_tizen 2.4
  * @param[in] window The EFL window
@@ -220,10 +220,10 @@ API int efl_util_get_window_screen_mode(Evas_Object *window, efl_util_screen_mod
 typedef void (*efl_util_window_screen_mode_error_cb)(Evas_Object *window, int error_code, void *user_data);
 
 /**
- * @deprecated Deprecated since_tizen 3.0
+ * @deprecated Deprecated since_tizen 3.0.
  * @brief Registers a callback function to be invoked when an error which set the screen mode.
- * @details An application can check error by the return value of efl_util_set_window_screen_mode.
  * @since_tizen 2.4
+ * @remarks An application can check error by the return value of efl_util_set_window_screen_mode.
  * @param[in] window The EFL window
  * @param[in] callback The callback function to register
  * @param[in] user_data The user data to be passed to the callback function
@@ -238,10 +238,10 @@ typedef void (*efl_util_window_screen_mode_error_cb)(Evas_Object *window, int er
 API int efl_util_set_window_screen_mode_error_cb(Evas_Object *window, efl_util_window_screen_mode_error_cb callback, void *user_data);
 
 /**
- * @deprecated Deprecated since_tizen 3.0
+ * @deprecated Deprecated since_tizen 3.0.
  * @brief Unregisters the callback function.
- * @details An application can check error by the return value of efl_util_set_window_screen_mode.
  * @since_tizen 2.4
+ * @remarks An application can check error by the return value of efl_util_set_window_screen_mode.
  * @param[in] window The EFL window
  * @return @c 0 on success, otherwise a negative error value
  * @retval #EFL_UTIL_ERROR_NONE Successful
@@ -364,7 +364,7 @@ typedef struct _efl_util_screenshot_h * efl_util_screenshot_h;
  * @privlevel platform
  * @privilege %http://tizen.org/privilege/screenshot
  * @remarks The specific error code can be obtained using the get_last_result()
- * method. Error codes are dedescribed in Exception section.
+ * method. Error codes are described in Exception section.
  * @param[in] width width of the screenshot surface
  * @param[in] height height of the screenshot surface
  * @return #efl_util_screenshot_h on success, otherwise @c NULL