diff --git a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_asym_cipher.h b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_asym_cipher.h index f07eea5cb43a39ef9eb88137472cf6597310d6d9..0302128260ff56371e7aa8bade7db2b55b2d95ed 100644 --- a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_asym_cipher.h +++ b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_asym_cipher.h @@ -56,7 +56,8 @@ typedef struct OH_CryptoAsymCipher OH_CryptoAsymCipher; * @param algoName 用于生成加密的算法名称。\n * 例如"RSA|PKCS1_OAEP|SHA384|MGF1_SHA384", "SM2|SM3"。 * @param ctx 指向非对称加密上下文的指针。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -71,7 +72,8 @@ OH_Crypto_ErrCode OH_CryptoAsymCipher_Create(const char *algoName, OH_CryptoAsym * @param ctx 非对称加密上下文。 * @param mode 加密模式是加密还是解密。 * @param key 非对称密钥。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -87,7 +89,8 @@ OH_Crypto_ErrCode OH_CryptoAsymCipher_Init(OH_CryptoAsymCipher *ctx, Crypto_Ciph * @param ctx 非对称加密上下文。 * @param in 要加密或解密的数据。 * @param out 最终加密或解密的数据。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -133,7 +136,8 @@ typedef enum { * * @param sm2Ciphertext SM2密文DER格式数据,如果为NULL则创建空的SM2密文规范。 * @param spec 输出的SM2密文规范。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -148,7 +152,8 @@ OH_Crypto_ErrCode OH_CryptoSm2CiphertextSpec_Create(Crypto_DataBlob *sm2Cipherte * @param spec SM2密文规范。 * @param item SM2密文规范项。 * @param out 输出数据。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -164,7 +169,8 @@ OH_Crypto_ErrCode OH_CryptoSm2CiphertextSpec_GetItem(OH_CryptoSm2CiphertextSpec * @param spec SM2密文规范。 * @param item SM2密文规范项。 * @param in 输入数据。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -179,7 +185,8 @@ OH_Crypto_ErrCode OH_CryptoSm2CiphertextSpec_SetItem(OH_CryptoSm2CiphertextSpec * * @param spec SM2密文规范。 * @param out 输出数据。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n diff --git a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_asym_key.h b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_asym_key.h index 7d89451e6e6c04ab7978e492546fa37d9f514147..7ca780b4e78b92759604918a40ec0839e84d2bfb 100644 --- a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_asym_key.h +++ b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_asym_key.h @@ -159,7 +159,8 @@ typedef struct OH_CryptoAsymKeyGenerator OH_CryptoAsymKeyGenerator; * @param algoName 用于生成生成器的算法名称。\n * 例如"RSA1024|PRIMES_2"。 * @param ctx 指向非对称密钥生成器上下文的指针。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -173,7 +174,8 @@ OH_Crypto_ErrCode OH_CryptoAsymKeyGenerator_Create(const char *algoName, OH_Cryp * * @param ctx 非对称密钥生成器实例。 * @param keyCtx 指向非对称密钥对实例的指针。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -190,7 +192,8 @@ OH_Crypto_ErrCode OH_CryptoAsymKeyGenerator_Generate(OH_CryptoAsymKeyGenerator * * @param pubKeyData 公钥数据。 * @param priKeyData 私钥数据。 * @param keyCtx 指向非对称密钥对实例的指针。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -250,7 +253,8 @@ OH_CryptoPrivKey *OH_CryptoKeyPair_GetPrivKey(OH_CryptoKeyPair *keyCtx); * @param type 编码类型。 * @param encodingStandard 编码格式。 * @param out 输出的公钥结果。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -266,7 +270,8 @@ OH_Crypto_ErrCode OH_CryptoPubKey_Encode(OH_CryptoPubKey *key, Crypto_EncodingTy * @param key 公钥实例。 * @param item 非对称密钥参数类型。 * @param value 参数输出值。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -299,7 +304,8 @@ typedef enum { * @brief 创建私钥编码参数。 * * @param ctx 私钥编码参数。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -314,7 +320,8 @@ OH_Crypto_ErrCode OH_CryptoPrivKeyEncodingParams_Create(OH_CryptoPrivKeyEncoding * @param ctx 私钥编码参数。 * @param type 私钥编码参数类型。 * @param value 私钥编码参数值。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -341,7 +348,8 @@ void OH_CryptoPrivKeyEncodingParams_Destroy(OH_CryptoPrivKeyEncodingParams *ctx) * 例如"PKCS8"。 * @param params 私钥编码参数,可以为NULL,如果要加密私钥,则应设置此参数。 * @param out 编码结果。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -357,7 +365,8 @@ OH_Crypto_ErrCode OH_CryptoPrivKey_Encode(OH_CryptoPrivKey *key, Crypto_Encoding * @param key 私钥。 * @param item 非对称密钥参数类型。 * @param value 输出数据。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -395,7 +404,8 @@ typedef enum { * * @param curveName ECC曲线名称。 * @param spec 指向EC通用参数规格的指针。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -410,7 +420,8 @@ OH_Crypto_ErrCode OH_CryptoAsymKeySpec_GenEcCommonParamsSpec(const char *curveNa * @param pLen 素数p的字节长度。 * @param skLen 私钥的字节长度。 * @param spec 指向DH通用参数规格的指针。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -426,7 +437,8 @@ OH_Crypto_ErrCode OH_CryptoAsymKeySpec_GenDhCommonParamsSpec(int pLen, int skLen * 例如"RSA"。 * @param type 非对称密钥规格类型。 * @param spec 指向非对称密钥规格的指针。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -442,7 +454,8 @@ OH_Crypto_ErrCode OH_CryptoAsymKeySpec_Create(const char *algoName, CryptoAsymKe * @param spec 非对称密钥规格。 * @param type 非对称密钥参数类型。 * @param value 输入数据。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -457,7 +470,8 @@ OH_Crypto_ErrCode OH_CryptoAsymKeySpec_SetParam(OH_CryptoAsymKeySpec *spec, Cryp * * @param spec 非对称密钥规格。 * @param commonParamsSpec 通用参数规格。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -473,7 +487,8 @@ OH_Crypto_ErrCode OH_CryptoAsymKeySpec_SetCommonParamsSpec(OH_CryptoAsymKeySpec * @param spec 非对称密钥规格。 * @param type 非对称密钥参数类型。 * @param value 输出数据。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -503,7 +518,8 @@ typedef struct OH_CryptoAsymKeyGeneratorWithSpec OH_CryptoAsymKeyGeneratorWithSp * * @param keySpec 非对称密钥规格。 * @param generator 带规格的非对称密钥生成器。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -518,7 +534,8 @@ OH_Crypto_ErrCode OH_CryptoAsymKeyGeneratorWithSpec_Create(OH_CryptoAsymKeySpec * * @param generator 带规格的非对称密钥生成器。 * @param keyPair 指向密钥对的指针。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -549,7 +566,8 @@ typedef struct OH_CryptoEcPoint OH_CryptoEcPoint; * @param curveName 曲线名称。 * @param ecKeyData EC点数据,支持"04 || x || y"、"02 || x"或"03 || x"格式。如果ecKeyData参数为NULL,将创建一个空的EC点规格。 * @param point 指向EC点的指针。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -564,7 +582,8 @@ OH_Crypto_ErrCode OH_CryptoEcPoint_Create(const char *curveName, Crypto_DataBlob * @param point EC点。 * @param x EC点的x坐标,可以为NULL。 * @param y EC点的y坐标,可以为NULL。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -579,7 +598,8 @@ OH_Crypto_ErrCode OH_CryptoEcPoint_GetCoordinate(OH_CryptoEcPoint *point, Crypto * @param point EC点。 * @param x EC点的x坐标。 * @param y EC点的y坐标。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -594,7 +614,8 @@ OH_Crypto_ErrCode OH_CryptoEcPoint_SetCoordinate(OH_CryptoEcPoint *point, Crypto * @param point EC点。 * @param format 编码格式,支持"UNCOMPRESSED"和"COMPRESSED"。 * @param out 编码后的EC点数据。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n diff --git a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_digest.h b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_digest.h index 2548d0ae925483172c288a2dd02d130e55865231..87da80b1b23ec4f8d831bdce322dedbfdf2dbf48 100644 --- a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_digest.h +++ b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_digest.h @@ -55,7 +55,8 @@ typedef struct OH_CryptoDigest OH_CryptoDigest; * @param algoName 用于生成摘要上下文的算法名称。\n * 例如"SHA256"。 * @param ctx 指向摘要上下文的指针。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -69,7 +70,8 @@ OH_Crypto_ErrCode OH_CryptoDigest_Create(const char *algoName, OH_CryptoDigest * * * @param ctx 指向摘要实例。 * @param in 传入的消息。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -84,7 +86,8 @@ OH_Crypto_ErrCode OH_CryptoDigest_Update(OH_CryptoDigest *ctx, Crypto_DataBlob * * * @param ctx 指向摘要实例。 * @param out 返回的Md的计算结果。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -98,7 +101,8 @@ OH_Crypto_ErrCode OH_CryptoDigest_Final(OH_CryptoDigest *ctx, Crypto_DataBlob *o * @brief 获取摘要长度。 * * @param ctx 指向摘要实例。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n diff --git a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_kdf.h b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_kdf.h index 0ace92e4c3d203b56c3ea602c6502218359affa1..d5e629b62deeac664d12a721892344e60b623442 100644 --- a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_kdf.h +++ b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_kdf.h @@ -93,7 +93,8 @@ typedef enum { * @param algoName KDF算法名称。\n * 例如"HKDF|SHA384|EXTRACT_AND_EXPAND"、"PBKDF2|SHA384"。 * @param params KDF参数。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -108,7 +109,8 @@ OH_Crypto_ErrCode OH_CryptoKdfParams_Create(const char *algoName, OH_CryptoKdfPa * @param params KDF参数。 * @param type KDF参数类型。 * @param value KDF参数值。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -131,7 +133,8 @@ void OH_CryptoKdfParams_Destroy(OH_CryptoKdfParams *params); * * @param algoName KDF算法名称。 * @param ctx KDF实例。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -147,7 +150,8 @@ OH_Crypto_ErrCode OH_CryptoKdf_Create(const char *algoName, OH_CryptoKdf **ctx); * @param params KDF参数。 * @param keyLen 密钥派生长度。 * @param key 派生出的密钥。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n diff --git a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_key_agreement.h b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_key_agreement.h index 0f42ee30692e19510e4bf9b7e5e7ef413f45c646..14f22910fba868079831327c8b098c98265235bd 100644 --- a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_key_agreement.h +++ b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_key_agreement.h @@ -56,7 +56,8 @@ typedef struct OH_CryptoKeyAgreement OH_CryptoKeyAgreement; * @param algoName 用于生成密钥协商实例的算法名称。\n * 例如"ECC"、"X25519"。 * @param ctx 密钥协商实例。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -72,7 +73,8 @@ OH_Crypto_ErrCode OH_CryptoKeyAgreement_Create(const char *algoName, OH_CryptoKe * @param privkey 私钥。 * @param pubkey 公钥。 * @param secret 秘密值。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n diff --git a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_mac.h b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_mac.h index 545bc2067890856da80de83ae612c4b56275b1e4..9ba740148db5711964047d3ba1ab29be1a6f6fb9 100644 --- a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_mac.h +++ b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_mac.h @@ -69,7 +69,8 @@ typedef enum { * @param algoName 用于生成MAC实例的算法名称。\n * 例如"HMAC"、"CMAC"。 * @param ctx MAC实例。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -82,9 +83,10 @@ OH_Crypto_ErrCode OH_CryptoMac_Create(const char *algoName, OH_CryptoMac **ctx); * @brief 设置MAC参数。 * * @param ctx MAC实例。 - * @param type MAC参数类型. - * @param value 参数。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @param type MAC参数类型。 + * @param value MAC参数。 + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -98,7 +100,8 @@ OH_Crypto_ErrCode OH_CryptoMac_SetParam(OH_CryptoMac *ctx, CryptoMac_ParamType t * * @param ctx MAC实例。 * @param key 对称密钥。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -113,8 +116,9 @@ OH_Crypto_ErrCode OH_CryptoMac_Init(OH_CryptoMac *ctx, const OH_CryptoSymKey *ke * @brief 更新MAC实例。 * * @param ctx MAC实例。 - * @param in 数据。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @param in 需要更新的数据。 + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -129,8 +133,9 @@ OH_Crypto_ErrCode OH_CryptoMac_Update(OH_CryptoMac *ctx, const Crypto_DataBlob * * @brief 完成MAC操作。 * * @param ctx MAC实例。 - * @param mac MAC值。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @param out MAC值。 + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -144,9 +149,10 @@ OH_Crypto_ErrCode OH_CryptoMac_Final(OH_CryptoMac *ctx, Crypto_DataBlob *out); /** * @brief 获取MAC长度。 * - * @param ctx 指向MAC实例。 + * @param ctx MAC实例。 * @param length MAC长度。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n diff --git a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_rand.h b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_rand.h index 8a9381e19a57bf6d341bf6b208de97ffd497e339..ce064355e45d3a3d0dd2dcbfbb62c4ff27efb81a 100644 --- a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_rand.h +++ b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_rand.h @@ -51,7 +51,8 @@ typedef struct OH_CryptoRand OH_CryptoRand; * @brief 创建随机数生成器。 * * @param ctx 指向随机数生成器实例的指针。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -66,7 +67,8 @@ OH_Crypto_ErrCode OH_CryptoRand_Create(OH_CryptoRand **ctx); * @param ctx 随机数生成器实例。 * @param len 表示生成随机数的长度,单位为byte,范围在[1, INT_MAX]。 * @param out 用于获取随机数的指针。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -89,7 +91,8 @@ const char *OH_CryptoRand_GetAlgoName(OH_CryptoRand *ctx); * * @param ctx 随机数生成器实例。 * @param seed 种子数据。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n diff --git a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_signature.h b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_signature.h index ec562cf7b666a1046ad75d19a3b747269ecaf7ca..1ecd254fdd6cf83717e65e8e0201f1b59d4a0821 100644 --- a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_signature.h +++ b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_signature.h @@ -84,7 +84,8 @@ typedef struct OH_CryptoSign OH_CryptoSign; * @param algoName 用于生成验签实例的算法名称。\n * 例如"RSA1024|PKCS1|SHA256" * @param verify 指向验签实例的指针。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -98,7 +99,8 @@ OH_Crypto_ErrCode OH_CryptoVerify_Create(const char *algoName, OH_CryptoVerify * * * @param ctx 指向验签实例。 * @param pubKey 公钥对象。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -114,7 +116,8 @@ OH_Crypto_ErrCode OH_CryptoVerify_Init(OH_CryptoVerify *ctx, OH_CryptoPubKey *pu * * @param ctx 指向验签实例。 * @param in 传入的消息。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -144,7 +147,8 @@ bool OH_CryptoVerify_Final(OH_CryptoVerify *ctx, Crypto_DataBlob *in, Crypto_Dat * @param ctx 指向验签实例。 * @param signData 签名数据。 * @param rawSignData 验签恢复的数据。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -169,7 +173,8 @@ const char *OH_CryptoVerify_GetAlgoName(OH_CryptoVerify *ctx); * @param ctx 指向验签实例。 * @param type 用于指定需要设置的验签参数。 * @param value 用于指定验签参数的具体值。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -185,7 +190,8 @@ OH_Crypto_ErrCode OH_CryptoVerify_SetParam(OH_CryptoVerify *ctx, CryptoSignature * @param ctx 指向验签实例。 * @param type 用于指定需要获取的验签参数。 * @param value 获取的验签参数的具体值。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -209,7 +215,8 @@ void OH_CryptoVerify_Destroy(OH_CryptoVerify *ctx); * @param algoName 用于生成签名实例的算法名称。\n * 例如"RSA|PKCS1|SHA384"、"ECC|SHA384"。 * @param sign 签名实例。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -223,7 +230,8 @@ OH_Crypto_ErrCode OH_CryptoSign_Create(const char *algoName, OH_CryptoSign **sig * * @param ctx 指向签名实例。 * @param privKey 私钥。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -239,7 +247,8 @@ OH_Crypto_ErrCode OH_CryptoSign_Init(OH_CryptoSign *ctx, OH_CryptoPrivKey *privK * * @param ctx 指向签名实例。 * @param in 需要签名的数据。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -256,7 +265,8 @@ OH_Crypto_ErrCode OH_CryptoSign_Update(OH_CryptoSign *ctx, const Crypto_DataBlob * @param ctx 指向签名实例。 * @param in 需要签名的数据。 * @param out 签名结果。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -282,7 +292,8 @@ const char *OH_CryptoSign_GetAlgoName(OH_CryptoSign *ctx); * @param ctx 指向签名实例。 * @param type 签名参数类型。 * @param value 输入数据。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -298,7 +309,8 @@ OH_Crypto_ErrCode OH_CryptoSign_SetParam(OH_CryptoSign *ctx, CryptoSignature_Par * @param ctx 指向签名实例。 * @param type 签名参数类型。 * @param value 输出数据。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -327,7 +339,8 @@ typedef struct OH_CryptoEccSignatureSpec OH_CryptoEccSignatureSpec; * * @param EccSignature ECC签名(DER格式),如果EccSignature参数为NULL,将创建一个空的ECC签名规范。 * @param spec 输出的ECC签名规范。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -343,7 +356,8 @@ OH_Crypto_ErrCode OH_CryptoEccSignatureSpec_Create(Crypto_DataBlob *EccSignature * @param spec 指向ECC签名规范。 * @param r r值。 * @param s s值。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -359,7 +373,8 @@ OH_Crypto_ErrCode OH_CryptoEccSignatureSpec_GetRAndS(OH_CryptoEccSignatureSpec * * @param spec 指向ECC签名规范。 * @param r r值。 * @param s s值。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -374,7 +389,8 @@ OH_Crypto_ErrCode OH_CryptoEccSignatureSpec_SetRAndS(OH_CryptoEccSignatureSpec * * * @param spec 指向ECC签名规范。 * @param out 输出数据。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n diff --git a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_sym_cipher.h b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_sym_cipher.h index 9f80d8f62a2b3bc29a39bb61bb52f3e7391b6b5b..8bbd15d11302fa0bc997ac3e262060c722bfd060 100644 --- a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_sym_cipher.h +++ b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_sym_cipher.h @@ -75,7 +75,8 @@ typedef struct OH_CryptoSymCipherParams OH_CryptoSymCipherParams; * @brief 创建对称密钥加解密参数实例。 * * @param params 指向对称加解密参数实例的指针。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -90,7 +91,8 @@ OH_Crypto_ErrCode OH_CryptoSymCipherParams_Create(OH_CryptoSymCipherParams **par * @param params 指向对称密钥加解密参数实例。 * @param paramsType 设置对称密钥加解密参数类型。 * @param value 设置的参数值。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -114,7 +116,8 @@ void OH_CryptoSymCipherParams_Destroy(OH_CryptoSymCipherParams *params); * @param algoName 用于生成加密上下文的算法名称。\n * 例如"AES128|GCM|PKCS7"。 * @param ctx 指向对称密钥加密上下文的指针。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -130,7 +133,8 @@ OH_Crypto_ErrCode OH_CryptoSymCipher_Create(const char *algoName, OH_CryptoSymCi * @param mod 加解密模式。 * @param key 对称密钥。 * @param params 指向对称密钥参数实例。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -148,7 +152,8 @@ OH_Crypto_ErrCode OH_CryptoSymCipher_Init(OH_CryptoSymCipher *ctx, Crypto_Cipher * @param ctx 指向对称密钥加解密实例。 * @param in 加密或者解密的数据。 * @param out 更新的结果。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -165,7 +170,8 @@ OH_Crypto_ErrCode OH_CryptoSymCipher_Update(OH_CryptoSymCipher *ctx, Crypto_Data * @param ctx 对称密钥加密上下文。 * @param in 要加密或解密的数据。 * @param out 返回剩余数据的加/解密结果。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n diff --git a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_sym_key.h b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_sym_key.h index aa06b1c5e631654a425eb82bb03d8678e3beff94..6f4073d67ddaa41a127ca8ea0e0d76b1fe57f5ee 100644 --- a/zh-cn/native_sdk/CryptoArchitectureKit/crypto_sym_key.h +++ b/zh-cn/native_sdk/CryptoArchitectureKit/crypto_sym_key.h @@ -62,7 +62,8 @@ typedef struct OH_CryptoSymKeyGenerator OH_CryptoSymKeyGenerator; * @param algoName 用于生成生成器的算法名称。\n * 例如"AES256"、"AES128"、"SM4"等。 * @param ctx 指向对称密钥生成器实例的指针。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -76,7 +77,8 @@ OH_Crypto_ErrCode OH_CryptoSymKeyGenerator_Create(const char *algoName, OH_Crypt * * @param ctx 指向对称密钥生成器实例。 * @param keyCtx 指向对称密钥的指针。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -91,7 +93,8 @@ OH_Crypto_ErrCode OH_CryptoSymKeyGenerator_Generate(OH_CryptoSymKeyGenerator *ct * @param ctx 指向对称密钥生成器实例。 * @param keyData 指向生成对称密钥的数据。 * @param keyCtx 指向对称密钥实例的指针。 - * @return CRYPTO_SUCCESS : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n @@ -132,7 +135,8 @@ const char *OH_CryptoSymKey_GetAlgoName(OH_CryptoSymKey *keyCtx); * * @param keyCtx 指向对称密钥实例。 * @param out 获取到的结果。 - * @return CRYPTO_SUCCESS = 0 : 操作成功。\n + * @return {@link OH_Crypto_ErrCode}: \n + * CRYPTO_SUCCESS = 0 : 操作成功。\n * CRYPTO_INVALID_PARAMS = 401 : 参数无效。\n * CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。\n * CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。\n