diff --git a/BasicServicesKit/os_account.h b/BasicServicesKit/os_account.h index 4f5816aab00468fda7b705fac0957d94eeb6d43e..15ef714bef725f3ffd6fa74ae2445e7ed5007b97 100644 --- a/BasicServicesKit/os_account.h +++ b/BasicServicesKit/os_account.h @@ -44,10 +44,10 @@ extern "C" { * * @param buffer The name character array which should have space for the name and the terminating character ('\0'). * @param buffer_size The size of the name character array. - * @return OS_ACCOUNT_ERR_OK - Indicates successful;
- * OS_ACCOUNT_ERR_INTERNAL_ERROR - Indicates the internal error.
- * OS_ACCOUNT_ERR_INVALID_PARAMETER - Indicates the buf is NULL pointer or the size of the name, - * including the terminating character ('\0'), is larger then buffer_size; + * @return {@link OS_ACCOUNT_ERR_OK} Indicates successful;
+ * {@link OS_ACCOUNT_ERR_INTERNAL_ERROR} Indicates the internal error.
+ * {@link OS_ACCOUNT_ERR_INVALID_PARAMETER} Indicates the buffer is NULL pointer or the size of the name, + * including the terminating character ('\0'), is larger than buffer_size; * @syscap SystemCapability.Account.OsAccount * @since 12 */ diff --git a/BasicServicesKit/os_account_common.h b/BasicServicesKit/os_account_common.h index cb1859436475a37c5e83202e49bcc592aacda830..d3cb14d28ee1d8a7ad70cfd29d02624e5c68e898 100644 --- a/BasicServicesKit/os_account_common.h +++ b/BasicServicesKit/os_account_common.h @@ -42,19 +42,13 @@ extern "C" { * @since 12 */ typedef enum OsAccount_ErrCode { - /** - * Operation is successful. - */ + /** @error Operation is successful.*/ OS_ACCOUNT_ERR_OK = 0, - /** - * Internal error. - */ + /** @error Internal error.*/ OS_ACCOUNT_ERR_INTERNAL_ERROR = 12300001, - /** - * Invalid parameter. - */ + /** @error Invalid parameter.*/ OS_ACCOUNT_ERR_INVALID_PARAMETER = 12300002 } OsAccount_ErrCode;