From 3a8bc0c0f0e9fb73e36d9da345be111c79a1af17 Mon Sep 17 00:00:00 2001 From: Piotr Sawicki Date: Fri, 21 Jul 2017 06:59:52 +0200 Subject: [PATCH] Clarify the CAPI documentation There are devices that don't have the hardware back and home buttons. Descriptions of enums have been simplified. Fix typos and other mistakes. Change-Id: I7db5311934717d04d91820b1c95550f5488c969a --- src/capi/include/privacy_privilege_manager.h | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/src/capi/include/privacy_privilege_manager.h b/src/capi/include/privacy_privilege_manager.h index 6747a2c..23ee43c 100644 --- a/src/capi/include/privacy_privilege_manager.h +++ b/src/capi/include/privacy_privilege_manager.h @@ -29,7 +29,7 @@ extern "C" { */ /** - * @brief Enumeration for error codes for Privacy Privilege Manager. + * @brief Enumeration for error codes of Privacy Privilege Manager. * @since_tizen 4.0 */ typedef enum @@ -49,7 +49,7 @@ typedef enum } ppm_error_e; /** - * @brief Enumeration for privilege check results. + * @brief Enumeration for results of a permission check. * @since_tizen 4.0 */ typedef enum { @@ -62,7 +62,7 @@ typedef enum { } ppm_check_result_e; /** - * @brief Enumeration for user decision results for the request permission resonse callback. + * @brief Enumeration for results of a permission request. * @since_tizen 4.0 */ typedef enum { @@ -75,7 +75,7 @@ typedef enum { } ppm_request_result_e; /** - * @brief Enumeration for status codes for the request permission response callback. + * @brief Enumeration for status codes of a permission request. * @since_tizen 4.0 */ typedef enum { @@ -135,10 +135,11 @@ int ppm_check_permission(const char *privilege, ppm_check_result_e *result); * sends the response back to the application. The possible response values are as follows: * #PRIVACY_PRIVILEGE_MANAGER_REQUEST_RESULT_ALLOW_FOREVER\n * #PRIVACY_PRIVILEGE_MANAGER_REQUEST_RESULT_DENY_FOREVER\n - * #PRIVACY_PRIVILEGE_MANAGER_PREQUEST_RESULT_DENY_ONCE\n - * The application receives #PRIVACY_PRIVILEGE_MANAGER_PREQUEST_RESULT_DENY_ONCE value after - * pressing 'Deny' button while not having selected checkbox 'Don't ask again?', or when - * one of the hardware buttons are pressed: home button or back button. + * #PRIVACY_PRIVILEGE_MANAGER_REQUEST_RESULT_DENY_ONCE\n + * The application receives #PRIVACY_PRIVILEGE_MANAGER_REQUEST_RESULT_DENY_ONCE value after + * pressing 'Deny' button while not having selected the 'Don't ask again?' checkbox. If the device + * has the home and back buttons, pressing either of them gives the + * #PRIVACY_PRIVILEGE_MANAGER_REQUEST_RESULT_DENY_ONCE response. * The application is informed about the user's decision by invoking ppm_request_response_cb(). * When a privacy policy for the given privilege has already been resolved, no pop-up will * be shown and the service will reply immediately with an appropriate result: @@ -148,7 +149,7 @@ int ppm_check_permission(const char *privilege, ppm_check_result_e *result); * @since_tizen 4.0 * * @remarks Before calling this function, call ppm_check_permission() to check if the application has - * permission to use the given privilege. If a result of calling ppm_check_permission() is + * permission to use the given privilege. If the result of calling ppm_check_permission() is * #PRIVACY_PRIVILEGE_MANAGER_CHECK_RESULT_ASK, the application should call * this function to determine access to the privilege. * -- 2.7.4