Make the CAPI documentation more consistent 65/139165/3
authorPiotr Sawicki <p.sawicki2@partner.samsung.com>
Mon, 17 Jul 2017 14:33:52 +0000 (16:33 +0200)
committerZofia Abramowska <z.abramowska@samsung.com>
Tue, 18 Jul 2017 14:17:16 +0000 (14:17 +0000)
Change-Id: I3c7048d8ec9a568f6125f25d17e4cda64a1cee9b

src/capi/include/privacy_privilege_manager.h

index e3a2e08..18aa2b2 100644 (file)
@@ -53,11 +53,11 @@ typedef enum
  * @since_tizen 4.0
  */
 typedef enum {
-    /**< An application has a privilege. */
+    /**< An application has permission to use a privilege. */
     PRIVACY_PRIVILEGE_MANAGER_CHECK_RESULT_ALLOW,
-    /**< An application doesn't have a privilege. */
+    /**< An application doesn't have permission to use a privilege. */
     PRIVACY_PRIVILEGE_MANAGER_CHECK_RESULT_DENY,
-    /**< A user has to be asked whether grant a privilege to an application or not. */
+    /**< A user has to be asked whether to grant permission to use a privilege. */
     PRIVACY_PRIVILEGE_MANAGER_CHECK_RESULT_ASK,
 } ppm_check_result_e;
 
@@ -66,11 +66,11 @@ typedef enum {
  * @since_tizen 4.0
  */
 typedef enum {
-    /**< A user granted a privilege to an application for an indefinite period of time. */
+    /**< A user granted permission to use a privilege for an indefinite period of time. */
     PRIVACY_PRIVILEGE_MANAGER_POPUP_RESULT_ALLOW_FOREVER,
-    /**< A user did not grant a privilege to an application for an indefinite period of time. */
+    /**< A user did not grant permission to use a privilege for an indefinite period of time. */
     PRIVACY_PRIVILEGE_MANAGER_POPUP_RESULT_DENY_FOREVER,
-    /**< A user did not grant a privilege to an application once. */
+    /**< A user did not grant permission to use a privilege once. */
     PRIVACY_PRIVILEGE_MANAGER_POPUP_RESULT_DENY_ONCE,
 } ppm_popup_result_e;
 
@@ -96,7 +96,7 @@ typedef enum {
  *                          This is a valid value only if the @a cause parameter is equal to
  *                          **PRIVACY_PRIVILEGE_MANAGER_CALL_CAUSE_ANSWER**.
  * @param[in]   privilege   A privilege that has been checked.
- * @param[in]   user_data   User specific data, this parameter has been passed
+ * @param[in]   user_data   User specific data, this pointer has been passed
  *                          to ppm_popup_request().
  *
  * @see ppm_popup_request()
@@ -107,7 +107,7 @@ typedef void (*ppm_popup_response_cb) (ppm_call_cause_e cause,
                                        void *user_data);
 
 /**
- * @brief Checks if an application, which calls this API, has permission for a
+ * @brief Checks if an application, which calls this API, has permission to use a
  * given privilege.
  *
  * @since_tizen 4.0
@@ -125,7 +125,7 @@ typedef void (*ppm_popup_response_cb) (ppm_call_cause_e cause,
 int ppm_check_privilege(const char *privilege, ppm_check_result_e *result);
 
 /**
- * @brief Requests a user's response to determine permission for a given privilege.
+ * @brief Requests a user's response to obtain permission for using a given privilege.
  *
  * @details When this function is called, an underlying service may show an appropriate
  * UI dialogue box (pop-up) with a question about granting the application access
@@ -137,20 +137,20 @@ int ppm_check_privilege(const char *privilege, ppm_check_result_e *result);
  * PRIVACY_PRIVILEGE_MANAGER_POPUP_RESULT_DENY_ONCE.
  * The application is informed about the user's decision by invoking previously
  * registered ppm_popup_response_callback. When a privacy policy for the given privilege
- * has already been resolved, no pop-up will be shown and the service will return
- * a response immediately with an appropriate value:
+ * has already been resolved, no pop-up will be shown and the service will reply
+ * immediately with an appropriate result:
  * PRIVACY_PRIVILEGE_MANAGER_POPUP_RESULT_ALLOW_FOREVER or
  * PRIVACY_PRIVILEGE_MANAGER_POPUP_RESULT_DENY_FOREVER.
  *
  * @since_tizen 4.0
  *
  * @remarks Before calling this function, call ppm_check_privilege() to check
- * permission for a given privilege. If a result of calling ppm_check_privilege() is
+ * permission to use a given privilege. If a result of calling ppm_check_privilege() is
  * **PRIVACY_PRIVILEGE_MANAGER_CHECK_RESULT_ASK**, an application should call
  * this function to determine whether a user allows the application to use
  * the privilege or not.
  *
- * @param[in]   privilege   A privilege for which a popup must be shown.
+ * @param[in]   privilege   A privilege for which a pop-up must be shown.
  * @param[in]   callback    A callback function which will be invoked
  *                          when the API receives a pop-up response.
  * @param[in]   user_data   User specific data which will be passed to