From a885b9e366f9f06a3e335965dde10a9509facf1d Mon Sep 17 00:00:00 2001 From: XiaoshuangMa Date: Wed, 8 Jun 2022 14:33:44 +0800 Subject: [PATCH] explanation Signed-off-by: XiaoshuangMa --- pin_auth/v1_0/IExecutor.idl | 10 +++++----- pin_auth/v1_0/IExecutorCallback.idl | 6 +++--- user_auth/v1_0/IUserAuthInterface.idl | 10 +++++----- user_auth/v1_0/UserAuthTypes.idl | 6 +++--- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/pin_auth/v1_0/IExecutor.idl b/pin_auth/v1_0/IExecutor.idl index 244e6b64..64099b78 100644 --- a/pin_auth/v1_0/IExecutor.idl +++ b/pin_auth/v1_0/IExecutor.idl @@ -81,11 +81,11 @@ interface IExecutor { */ OnRegisterFinish([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo); /** - * @brief Send parameters to driver when executor register finish. + * @brief Set pin data to driver. * - * @param scheduleId Indicates schedule id of enroll. - * @param authSubType . - * @param data . + * @param scheduleId Indicates schedule id of the enrollment. + * @param authSubType Indicates the pin sub type. + * @param data Indicates the pin data. * * @return Returns 0 if the operation is successful. * @return Returns a non-zero value if the operation fails. @@ -124,7 +124,7 @@ interface IExecutor { */ Delete([in] unsigned long templateId); /** - * @brief Cancel enroll, authenticate or identify operation. + * @brief Cancel operation. * * @param scheduleId Indicates schedule id of operation to cancel. * diff --git a/pin_auth/v1_0/IExecutorCallback.idl b/pin_auth/v1_0/IExecutorCallback.idl index 8dc4922f..6c8dadca 100644 --- a/pin_auth/v1_0/IExecutorCallback.idl +++ b/pin_auth/v1_0/IExecutorCallback.idl @@ -57,10 +57,10 @@ package ohos.hdi.pin_auth.v1_0; */ OnResult([in] int result, [in] unsigned char[] extraInfo); /** - * @brief defines the function for reporting info in process. + * @brief defines the function for getting pin data. * - * @param salt Indicates acquire info code, see {@link FaceTipsCode}. - * @param authSubType Indicates extra info to report. + * @param salt Indicates the value used to compute pin data. + * @param authSubType Indicates pin sub type. * * @return Returns 0 if the operation is successful. * @return Returns a non-zero value if the operation fails. diff --git a/user_auth/v1_0/IUserAuthInterface.idl b/user_auth/v1_0/IUserAuthInterface.idl index f13a2e6e..5c42d7e6 100644 --- a/user_auth/v1_0/IUserAuthInterface.idl +++ b/user_auth/v1_0/IUserAuthInterface.idl @@ -19,8 +19,8 @@ * * @brief Provides APIs for the user auth driver. * - * The user auth driver provides a unified interface for the pin auth service to access the user auth driver. - * After obtaining the pin auth driver proxy, the service can call related APIs to register executor, + * The user auth driver provides a unified interface for the user auth service to access the user auth driver. + * After obtaining the user auth driver proxy, the service can call related APIs to register executor, * manage credentials, and complete password and biometric authentication. * @since 3.2 */ @@ -146,7 +146,7 @@ interface IUserAuthInterface { /** * @brief Query credential information. * - * @param userId Indicates Indicates user id. + * @param userId Indicates user id. * @param authType Indicates authentication type, see {@link AuthType}. * @param infos Indicates credential information, see {@link CredentialInfo}. * @@ -158,7 +158,7 @@ interface IUserAuthInterface { * @brief Query secure information. * * @param userId Indicates user id. - * @param secureUid Indicates secure user id, see {@link AuthType}. + * @param secureUid Indicates secure user id. * @param infos Indicates enrolled Info, see {@link EnrolledInfo}. * * @return Returns 0 if the operation is successful. @@ -169,7 +169,7 @@ interface IUserAuthInterface { * @brief Delete pin, delete user in Iam subsystem. * * @param userId Indicates user id. - * @param authToken Indicates Indicates user password authentication token. + * @param authToken Indicates user password authentication token. * @param deletedInfos Indicates deleted credential information, see {@link CredentialInfo}. * * @return Returns 0 if the operation is successful. diff --git a/user_auth/v1_0/UserAuthTypes.idl b/user_auth/v1_0/UserAuthTypes.idl index 6c05a62f..89a36eff 100644 --- a/user_auth/v1_0/UserAuthTypes.idl +++ b/user_auth/v1_0/UserAuthTypes.idl @@ -49,7 +49,7 @@ enum AuthType : int { enum ExecutorRole : int { COLLECTOR = 1, /**< Indicates executor role is collector. */ VERIFIER = 2, /**< Indicates executor role is verifier. */ - ALL_IN_ONE = 3, /**< Indicates executor role is collector and verifier. */ + ALL_IN_ONE = 3, /**< Indicates executor role is combination of collector and verifier. */ }; /** @@ -85,7 +85,7 @@ struct ScheduleInfo { enum AuthType authType; /**< Indicates authentication type, see @{AuthType}. */ unsigned int executorType; /**< Indicates executor type. */ unsigned int scheduleMode; /**< Indicates authentication or identification. */ - struct ExecutorInfo[] executors; /**< Indicates executor info of identification, see @{ExecutorInfo}. */ + struct ExecutorInfo[] executors; /**< Indicates executor information, see @{ExecutorInfo}. */ }; struct AuthSolution { @@ -104,7 +104,7 @@ struct ExecutorSendMsg { struct AuthResultInfo { unsigned int result; /**< Indicates result. */ int freezingTime; /**< Indicates freezing time in seconds. */ - int remainTimes; /**< Indicates freezing time in seconds. */ + int remainTimes; /**< Indicates remaining authentication times before a lockout. */ struct ExecutorSendMsg[] msgs; /**< Indicates executor msgs, see @{ExecutorSendMsg}. */ unsigned char[] token; /**< Indicates authentication token. */ }; -- Gitee