From: Kyungwook Tak Date: Wed, 4 May 2016 08:11:06 +0000 (+0900) Subject: Fix descriptions of CAPI X-Git-Tag: accepted/tizen/common/20160614.143943^2~157 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=7a7920047f9bd2cf6c2fa69c5d5e19d0e9f58348;p=platform%2Fupstream%2Fcsr-framework.git Fix descriptions of CAPI Change-Id: Id7b78729a04fe7e46b45ba1d0345a6705f50cc99 Signed-off-by: Kyungwook Tak --- diff --git a/src/include/csr/content-screening-types.h b/src/include/csr/content-screening-types.h index 7114353..23fee78 100644 --- a/src/include/csr/content-screening-types.h +++ b/src/include/csr/content-screening-types.h @@ -17,7 +17,7 @@ * @file content-screening-types.h * @author Dongsun Lee (ds73.lee@samsung.com) * @version 1.0 - * @brief + * @brief Content screening CAPI enums, handles and callbacks */ #ifndef __CSR_CONTENT_SCREENING_TYPES_H_ #define __CSR_CONTENT_SCREENING_TYPES_H_ @@ -27,28 +27,28 @@ extern "C" { #endif /** - * @brief Severity level of an detected malware + * @brief Severity level of a detected malware */ typedef enum { - CSR_CS_SEVERITY_LOW = 0x01, /**< Low Severity. Process with a warning log. */ - CSR_CS_SEVERITY_MEDIUM = 0x02, /**< Medium Severity. Prompt the user before processing. Ask the user if the user wants the application to process the data. */ - CSR_CS_SEVERITY_HIGH = 0x03 /**< High Severity. Do not process the data and prompt user for removal. */ + CSR_CS_SEVERITY_LOW = 0x01, /**< Low Severity. User can choose how to handle between skip, ignore and remove. */ + CSR_CS_SEVERITY_MEDIUM = 0x02, /**< Medium Severity. User can choose how to handle between skip, ignore and remove. */ + CSR_CS_SEVERITY_HIGH = 0x03 /**< High Severity. User cah choose how to handle between skip and remove. */ } csr_cs_severity_level_e; /** - * @brief the options about prompting a popup to a user. + * @brief the option of asking user about handling a detected malware */ typedef enum { CSR_CS_NOT_ASK_USER = 0x00, /**< Do not ask the user even if malicious contents were found.*/ - CSR_CS_ASK_USER = 0x01 /**< Ask the user when malicious contents were found */ + CSR_CS_ASK_USER = 0x01 /**< Ask the user when malicious contents were found. */ } csr_cs_ask_user_e; /** - * @brief the user response for a popup. + * @brief the user response from popup */ typedef enum { - CSR_CS_NO_ASK_USER = 0x00, /**< There was no popup for asking the user. */ - CSR_CS_REMOVE = 0x01, /**< A user decided to remove a detected malicious content and it was removed */ + CSR_CS_NO_ASK_USER = 0x00, /**< No response from user. */ + CSR_CS_REMOVE = 0x01, /**< A user decided to remove a detected malicious content and it was removed. */ CSR_CS_IGNORE = 0x02, /**< A user decided to ignore a detected malicious content. */ CSR_CS_SKIP = 0x03, /**< A user decided to skip a detected malicious content. */ CSR_CS_PROCESSING_ALLOWED = 0x04, /**< A user decided to process a detected malicious data. */ @@ -56,75 +56,73 @@ typedef enum { } csr_cs_user_response_e; /** - * @brief the action types for the detected malware files + * @brief the action types for the detected malware files */ typedef enum { - CSR_CS_ACTION_REMOVE = 0x00, /* Remove the detected malware file */ - CSR_CS_ACTION_IGNORE = 0x01, /* Ignore the detected malware file */ - CSR_CS_ACTION_UNIGNORE = 0x02 /* Unignore the previously ignored file */ + CSR_CS_ACTION_REMOVE = 0x00, /* Remove the detected malware file. */ + CSR_CS_ACTION_IGNORE = 0x01, /* Ignore the detected malware file. */ + CSR_CS_ACTION_UNIGNORE = 0x02 /* Unignore the previously ignored file. */ } csr_cs_action_e; /** * @brief Maximum core usage during scanning */ typedef enum { - CSR_CS_USE_CORE_DEFAULT = 0x00, /* Use default setting value */ + CSR_CS_USE_CORE_DEFAULT = 0x00, /* Use default setting value. */ CSR_CS_USE_CORE_ALL = 0x01, /* Use all cores during scanning. */ CSR_CS_USE_CORE_HALF = 0x02, /* Use half cores during scanning. */ - CSR_CS_USE_CORE_SINGLE = 0x03 /* Use a single core during scanning */ + CSR_CS_USE_CORE_SINGLE = 0x03 /* Use a single core during scanning. */ } csr_cs_core_usage_e; /** - * @brief TCS context handle. + * @brief context handle of content screening APIs. */ typedef struct __csr_cs_context_s *csr_cs_context_h; /** - * @brief TCS detected malware info handle. + * @brief detected malware handle. */ typedef struct __csr_cs_detected_s *csr_cs_detected_h; /** - * @brief TCS detected malware list handle + * @brief detected malware list handle. */ typedef struct __csr_cs_detected_list_s *csr_cs_detected_list_h; /** - * @brief TCS engine info handle. + * @brief engine info handle. */ typedef struct __csr_cs_engine_s *csr_cs_engine_h; /** - * @brief The callback function is called when a malware detected.\ + * @brief The callback function is called when a malware detected. \ * It's only for an asynchronous scan function. */ -typedef void (*csr_cs_on_detected_cb)(void *user_data, - csr_cs_detected_h detected); +typedef void (*csr_cs_on_detected_cb)(void *user_data, csr_cs_detected_h detected); /** - * @brief The callback function is called when scanning is fininshed without an error.\ + * @brief The callback function is called when scanning is fininshed without an error. \ * It's only for an asynchronous scan function. */ typedef void (*csr_cs_on_completed_cb)(void *user_data); /** - * @brief The callback function is called when scanning is cancelled without an error.\ + * @brief The callback function is called when scanning is cancelled without an error. \ * It's only for an asynchronous scan function. */ typedef void (*csr_cs_on_cancelled_cb)(void *user_data); /** - * @brief The callback function is called when scanning is fininshed with an error.\ + * @brief The callback function is called when scanning is fininshed with an error. \ * It's only for an asynchronous scan function. */ typedef void (*csr_cs_on_error_cb)(void *user_data, int error_code); /** - * @brief The callback function is called when a file scan is completed.\ + * @brief The callback function is called when a file scanning is completed. \ * It's only for an asynchronous scan function. */ -typedef void (*csr_cs_on_file_scanned_cb)(void *user_data, - const char *file_path); +typedef void (*csr_cs_on_file_scanned_cb)(void *user_data, const char *file_path); #ifdef __cplusplus } diff --git a/src/include/csr/content-screening.h b/src/include/csr/content-screening.h index 3202f77..4e17e26 100644 --- a/src/include/csr/content-screening.h +++ b/src/include/csr/content-screening.h @@ -108,7 +108,8 @@ int csr_cs_set_ask_user(csr_cs_context_h handle, csr_cs_ask_user_e ask_user); * * @retval #CSR_ERROR_NONE Successful * @retval #CSR_ERROR_INVALID_HANDLE Invalid handle - * @retval #CSR_ERROR_INVALID_PARAMETER message is invalid. Max size is 64 bytes. + * @retval #CSR_ERROR_INVALID_PARAMETER @a message is too long or empty. Max size + * is 64 bytes. * @retval #CSR_ERROR_UNKNOWN Error with unknown reason * * @see csr_cs_context_create() diff --git a/src/include/csr/web-protection-types.h b/src/include/csr/web-protection-types.h index b19043d..9f7c16e 100644 --- a/src/include/csr/web-protection-types.h +++ b/src/include/csr/web-protection-types.h @@ -27,11 +27,6 @@ extern "C" { #endif /** - * @brief Maximum message size. - */ -#define MAX_MESSAGE_SIZE 64 - -/** * CSR WP context handle. */ typedef struct __csr_wp_context_s *csr_wp_context_h; diff --git a/src/include/csr/web-protection.h b/src/include/csr/web-protection.h index ad92bfa..ba12303 100644 --- a/src/include/csr/web-protection.h +++ b/src/include/csr/web-protection.h @@ -111,7 +111,8 @@ int csr_wp_set_ask_user(csr_wp_context_h handle, csr_wp_ask_user_e ask_user); * * @retval #CSR_ERROR_NONE Successful * @retval #CSR_ERROR_INVALID_HANDLE Invalid handle - * @retval #CSR_ERROR_INVALID_PARAMETER message is invalid. Max size is 64 bytes. + * @retval #CSR_ERROR_INVALID_PARAMETER @a message is too long or empty. Max size + * is 64 bytes. * @retval #CSR_ERROR_UNKNOWN Error with unknown reason * * @see csr_wp_context_create()