Update API reference and doc

- Update doc as suggested at https://review.tizen.org/gerrit/#/c/platform/core/security/privilege-info/+/230663/

Change-Id: Ic88b19163506c495812724e180442d32269c917e
Signed-off-by: Yunjin Lee <yunjin-.lee@samsung.com>

diff --git a/doc/privilege-info_doc.h b/doc/privilege-info_doc.h
index d47d785df37fa02eb8b7c33109e9e5d5e8e6feea..784886551394e2eda1f4af08360fb293c1ad41a5 100755 (executable)
--- a/doc/privilege-info_doc.h
+++ b/doc/privilege-info_doc.h
@@ -28,7 +28,7 @@
  * @section CAPI_SECURITY_FRAMEWORK_PRIVILEGE_INFO_MODULE_OVERVIEW Overview
  * A library for reading privilege information of the given privilege and API issue version.
  * It provides the display name or description of privileges.
- * If there's no matching privilege then it returns error.
+ * If there's no matching privilege then it returns an error.
  *
  * @section CAPI_SECURITY_FRAMEWORK_PRIVILEGE_INFO_MODULE_FEATURE Related Features
  * This API is related with the following features:\n

diff --git a/src/include/privilege_information.h b/src/include/privilege_information.h
index f1eb304555ee3de72a5a3294b87c1800bbd21865..9006dbc6129f973bf05453eb25cfaa0273b8a2ef 100755 (executable)
--- a/src/include/privilege_information.h
+++ b/src/include/privilege_information.h
@@ -55,7 +55,7 @@ typedef enum {
  * @brief Gets the display name of the given privilege.
  * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
  * @remarks @a display_name must be released using free().
- * @remarks Since 6.0, it will return #PRVINFO_ERROR_NO_MATCHING_PRIVILEGE if the given @a privilege not exist.
+ * @remarks Since 6.0, this function returns #PRVINFO_ERROR_NO_MATCHING_PRIVILEGE if the given @a privilege doesn't exist.
  * @param[in] api_version The API version of the application to get privilege information
  * @param[in] privilege The privilege
  * @param[out] display_name The display name of the privilege
@@ -75,7 +75,7 @@ int privilege_info_get_display_name(const char *api_version, const char *privile
  * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
  * @remarks @a display_name must be released using free().
  * @remarks @a package_type must be one of followings: "PRVINFO_PACKAGE_TYPE_NATIVE", "PRVINFO_PACKAGE_TYPE_WEB"
- * @remarks Since 6.0, it will return #PRVINFO_ERROR_NO_MATCHING_PRIVILEGE if the given @a privilege not exist.
+ * @remarks Since 6.0, this function returns #PRVINFO_ERROR_NO_MATCHING_PRIVILEGE if the given @a privilege doesn't exist.
  * @param[in] package_type The type of application package
  * @param[in] api_version The API version of the application to get privilege information
  * @param[in] privilege The privilege
@@ -95,7 +95,7 @@ int privilege_info_get_display_name_by_pkgtype(const char *package_type, const c
  * @brief Gets the description of the given privilege.
  * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
  * @remarks @a description must be released using free().
- * @remarks Since 6.0, it will return #PRVINFO_ERROR_NO_MATCHING_PRIVILEGE if the given @a privilege not exist.
+ * @remarks Since 6.0, this function returns #PRVINFO_ERROR_NO_MATCHING_PRIVILEGE if the given @a privilege doesn't exist.
  * @param[in] api_version The API version of the application to get privilege information
  * @param[in] privilege The privilege
  * @param[out] description The description of the privilege
@@ -115,7 +115,7 @@ int privilege_info_get_description(const char *api_version, const char *privileg
  * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
  * @remarks @a description must be released using free().
  * @remarks @a package_type must be one of followings: "PRVINFO_PACKAGE_TYPE_NATIVE", "PRVINFO_PACKAGE_TYPE_WEB"
- * @remarks Since 6.0, it will return #PRVINFO_ERROR_NO_MATCHING_PRIVILEGE if the given @a privilege not exist.
+ * @remarks Since 6.0, this function returns #PRVINFO_ERROR_NO_MATCHING_PRIVILEGE if the given @a privilege doesn't exist.
  * @param[in] package_type The type of application package
  * @param[in] api_version The API version of the application to get privilege information
  * @param[in]  privilege The privilege