Update doxygen

Change-Id: I5dd14cdd4fff4373c61fbcc5342ed67f0027e911
Signed-off-by: mk5004.lee <mk5004.lee@samsung.com>

diff --git a/include/badge.h b/include/badge.h
index f321149..e972330 100644 (file)
--- a/include/badge.h
+++ b/include/badge.h
@@ -50,7 +50,7 @@ enum badge_action {
 };
 
 /**
- * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif Use badge_add instead.
+ * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif Use badge_add() instead.
  * @brief Creates a badge for the application itself.
  * @details Creates new badge to display.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@@ -59,11 +59,11 @@ enum badge_action {
  * @param[in] writable_app_id The id of application which is authorized to change the badge
  * @return #BADGE_ERROR_NONE if success, other value if failure
  * @retval #BADGE_ERROR_NONE Success
+ * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #BADGE_ERROR_PERMISSION_DENIED Permission denied
  * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
  * @retval #BADGE_ERROR_IO_ERROR Error from I/O
  * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
- * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
  * @see #badge_error_e
  * @par Sample code:
  * @code
@@ -89,15 +89,15 @@ int badge_new(const char *writable_app_id) TIZEN_DEPRECATED_API;
  * @remarks Creating and updating a badge of the other application is allowed only when both applications are signed with the same certificate.
  * @param[in] badge_app_id The id of the application for which the badge will be created. This parameter can be null when creating a badge for itself.
  * @return #BADGE_ERROR_NONE If success, other value if failure
+ * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #BADGE_ERROR_PERMISSION_DENIED Permission denied
  * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
  * @retval #BADGE_ERROR_IO_ERROR Error from I/O
  * @retval #BADGE_ERROR_FROM_DB Error from DB
  * @retval #BADGE_ERROR_ALREADY_EXIST Already exist
  * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
  * @retval #BADGE_ERROR_INVALID_PACKAGE The caller application is not signed with the certificate of the badge_app_id
- * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
  * @see #badge_error_e
  * @par Sample code:
  * @code
@@ -122,14 +122,14 @@ int badge_add(const char *badge_app_id);
  * @param[in] app_id The name of the designated application
  * @return #BADGE_ERROR_NONE if success, other value if failure
  * @retval #BADGE_ERROR_NONE Success
+ * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #BADGE_ERROR_PERMISSION_DENIED Permission denied
  * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
  * @retval #BADGE_ERROR_IO_ERROR Error from I/O
  * @retval #BADGE_ERROR_FROM_DB Error from DB
  * @retval #BADGE_ERROR_NOT_EXIST Not exist
  * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
- * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
  * @see #badge_error_e
  * @par Sample code:
  * @code
@@ -156,14 +156,14 @@ int badge_remove(const char *app_id);
  * @param[in] count The count of the badge
  * @return #BADGE_ERROR_NONE if success, other value if failure
  * @retval #BADGE_ERROR_NONE Success
+ * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #BADGE_ERROR_PERMISSION_DENIED Permission denied
  * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
  * @retval #BADGE_ERROR_IO_ERROR Error from I/O
  * @retval #BADGE_ERROR_FROM_DB Error from DB
  * @retval #BADGE_ERROR_NOT_EXIST Not exist
  * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
- * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
  * @see #badge_error_e
  * @see badge_add()
  * @par Sample code:
@@ -191,14 +191,14 @@ int badge_set_count(const char *app_id, unsigned int count);
  * @param[out] count The count of the badge
  * @return #BADGE_ERROR_NONE if success, other value if failure
  * @retval #BADGE_ERROR_NONE Success
+ * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #BADGE_ERROR_PERMISSION_DENIED Permission denied
  * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
  * @retval #BADGE_ERROR_IO_ERROR Error from I/O
  * @retval #BADGE_ERROR_FROM_DB Error from DB
  * @retval #BADGE_ERROR_NOT_EXIST Not exist
  * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
- * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
  * @see #badge_error_e
  * @see badge_add()
  * @see badge_set_count()
@@ -228,14 +228,14 @@ int badge_get_count(const char *app_id, unsigned int *count);
  * @param[in] is_display The display option (1 = display, 0 = not display)
  * @return #BADGE_ERROR_NONE if success, other value if failure
  * @retval #BADGE_ERROR_NONE Success
+ * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #BADGE_ERROR_PERMISSION_DENIED Permission denied
  * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
  * @retval #BADGE_ERROR_IO_ERROR Error from I/O
  * @retval #BADGE_ERROR_FROM_DB Error from DB
  * @retval #BADGE_ERROR_NOT_EXIST Not exist
  * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
- * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
  * @see #badge_error_e
  * @see badge_add()
  * @par Sample code:
@@ -263,14 +263,14 @@ int badge_set_display(const char *app_id, unsigned int is_display);
  * @param[out]  is_display The display option (1 = display, 0 = not display)
  * @return #BADGE_ERROR_NONE if success, other value if failure
  * @retval #BADGE_ERROR_NONE Success
+ * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #BADGE_ERROR_PERMISSION_DENIED Permission denied
  * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
  * @retval #BADGE_ERROR_IO_ERROR Error from I/O
  * @retval #BADGE_ERROR_FROM_DB Error from DB
  * @retval #BADGE_ERROR_NOT_EXIST Not exist
  * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
- * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
  * @see #badge_error_e
  * @see badge_add()
  * @see badge_set_count()
@@ -291,11 +291,11 @@ int badge_set_display(const char *app_id, unsigned int is_display);
 int badge_get_display(const char *app_id, unsigned int *is_display);
 
 /**
- * @brief Callback function for getting result of badge_foreach.
+ * @brief Callback function for getting result of badge_foreach().
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] app_id The id of the application
  * @param[in] count The count of the badge
- * @param[in] user_data The user data passed from the badge_foreach function
+ * @param[in] user_data The user data passed from the badge_foreach()
  * @return true to continue with the next iteration of the loop, false to break out of the loop
  * @pre badge_foreach() will invoke this callback.
  * @see badge_foreach()
@@ -312,14 +312,14 @@ typedef bool (*badge_foreach_cb)(const char *app_id, unsigned int count, void *u
  * @param[in] user_data The user data to be passed to the callback function
  * @return #BADGE_ERROR_NONE if success, other value if failure
  * @retval #BADGE_ERROR_NONE Success
+ * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #BADGE_ERROR_PERMISSION_DENIED Permission denied
  * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
  * @retval #BADGE_ERROR_IO_ERROR Error from I/O
  * @retval #BADGE_ERROR_FROM_DB Error form DB
  * @retval #BADGE_ERROR_NOT_EXIST Not exist
  * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
- * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
  * @see #badge_error_e
  * @see badge_foreach_cb()
  */
@@ -348,12 +348,12 @@ typedef void (*badge_change_cb)(unsigned int action, const char *app_id,
  * @param[in] user_data The user data to be passed to the callback function
  * @return #BADGE_ERROR_NONE if success, other value if failure
  * @retval #BADGE_ERROR_NONE Success
+ * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #BADGE_ERROR_PERMISSION_DENIED Permission denied
  * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
  * @retval #BADGE_ERROR_IO_ERROR Error from I/O
  * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory
  * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
- * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
  * @see #badge_error_e
  * @see badge_add()
  * @see badge_remove()
@@ -369,10 +369,10 @@ int badge_register_changed_cb(badge_change_cb callback, void *user_data);
  * @param[in] callback The callback function
  * @return #BADGE_ERROR_NONE if success, other value if failure
  * @retval #BADGE_ERROR_NONE Success
+ * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #BADGE_ERROR_PERMISSION_DENIED Permission denied
  * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
  * @retval #BADGE_ERROR_NOT_EXIST Not exist
- * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
  * @see #badge_error_e
  * @see badge_register_changed_cb()
  */

diff --git a/include/badge_internal.h b/include/badge_internal.h
index ed0988a..b4876f7 100644 (file)
--- a/include/badge_internal.h
+++ b/include/badge_internal.h
@@ -50,21 +50,21 @@ typedef struct badge_info {
 
 /**
  * @internal
- * @brief This function checks whether badge service is ready
+ * @brief Checks whether badge service is ready.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/notification
  * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
  * @return 1 if badge service is ready, other value if badge service isn't ready
  * @retval BADGE_ERROR_NONE Success
- * @retval BADGE_ERROR_SERVICE_NOT_READY Service is not ready
  * @retval BADGE_ERROR_NOT_SUPPORTED Not supported
+ * @retval BADGE_ERROR_SERVICE_NOT_READY Service is not ready
  */
 int badge_is_service_ready(void);
 
 /**
  * @internal
- * @brief This function adds deferred task. the registered task will be executed when badge service become ready
+ * @brief Adds deferred task. The registered task will be executed when badge service become ready.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/notification
@@ -72,9 +72,9 @@ int badge_is_service_ready(void);
  * @param[in] user_data The user data to be passed to the callback function
  * @return #BADGE_ERROR_NONE if success, other value if failure
  * @retval BADGE_ERROR_NONE Success
- * @retval BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
- * @retval BADGE_ERROR_OUT_OF_MEMORY Out of memory
  * @retval BADGE_ERROR_NOT_SUPPORTED Not supported
+ * @retval BADGE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval BADGE_ERROR_OUT_OF_MEMORY Out of memory
  * @see #badge_error_e
  * @see badge_is_service_ready()
  */
@@ -83,16 +83,16 @@ int badge_add_deferred_task(
 
 /**
  * @internal
- * @brief This function removes deferred task.
+ * @brief Removes deferred task.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/notification
  * @param[in] badge_add_deferred_task The callback function
  * @return #BADGE_ERROR_NONE if success, other value if failure
  * @retval BADGE_ERROR_NONE Success
- * @retval BADGE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
  * @retval BADGE_ERROR_NOT_SUPPORTED Not supported
+ * @retval BADGE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval BADGE_ERROR_INVALID_PARAMETER Invalid parameter
  * @see #badge_error_e
  * @see badge_is_service_ready()
  */
@@ -109,13 +109,13 @@ int badge_del_deferred_task(
  * @param[out] existing The bool value of badge existence status
  * @return #BADGE_ERROR_NONE if success, other value if failure
  * @retval BADGE_ERROR_NONE Success
+ * @retval BADGE_ERROR_NOT_SUPPORTED Not supported
+ * @retval BADGE_ERROR_PERMISSION_DENIED Permission denied
  * @retval BADGE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
  * @retval BADGE_ERROR_FROM_DB Error from DB
  * @retval BADGE_ERROR_OUT_OF_MEMORY Out of memory
  * @retval BADGE_ERROR_NOT_EXIST Not exist
  * @retval BADGE_ERROR_SERVICE_NOT_READY Service is not ready
- * @retval BADGE_ERROR_NOT_SUPPORTED Not supported
  * @see #badge_error_e
  * @see badge_new()
  * @see badge_remove()
@@ -171,14 +171,14 @@ void badge_changed_cb_call(unsigned int action, const char *pkgname,
 /**
  * @internal
  * @brief Creates a badge for the designated package.
+ * @details Creates new badge to display.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/notification
- * @details Creates new badge to display.
  * @param[in] pkgname The name of the designated package
  * @param[in] writable_pkg The name of package which is authorized to change the badge
  * @return #BADGE_ERROR_NONE if success, other value if failure
- * @retval BADGE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
  * @see #badge_error_e
  * @par Sample code:
  * @code
@@ -204,16 +204,16 @@ int badge_new_for_uid(const char *writable_app_id, uid_t uid);
 /**
  * @internal
  * @brief Creates a badge for the application specified by the badge_app_id.
+ * @details Creates new badge to display.
  * @since_tizen 5.5
  * @privlevel public
  * @privilege %http://tizen.org/privilege/notification
- * @details Creates new badge to display.
  * @param[in] badge_app_id The id of the application for which the badge will be created. This should be the same package id with the caller application's package id
  * @param[in] writable_app_id The id of the application which is authorized to change the badge
  * @return #BADGE_ERROR_NONE if success, other value if failure
  * @retval #BADGE_ERROR_NONE Success
+ * @retval #BADGE_ERROR_PERMISSION_DENIED Permission denied
  * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
  * @retval #BADGE_ERROR_IO_ERROR Error from I/O
  * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
  * @retval #BADGE_ERROR_INVALID_PACKAGE Error while caller package is different with the id of the application badge creates