Skip to content

Fix issues with the API documentation #9458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+193 −185
Open

Fix issues with the API documentation #9458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/dox_comments/header_files/aes.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1021,7 +1021,7 @@ int wc_AesInit(Aes* aes, void* heap, int devId);
\sa wc_AesInit
*/
int wc_AesFree(Aes* aes);
void wc_AesFree(Aes* aes);

/*!
\ingroup AES
Expand Down
3 changes: 1 addition & 2 deletions doc/dox_comments/header_files/asn_public.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
\sa wc_MakeCert
\sa wc_MakeCertReq
*/
int wc_InitCert(Cert*);
int wc_InitCert(Cert* cert);

/*!
\ingroup ASN
Expand Down Expand Up @@ -2524,4 +2524,3 @@ int wc_Asn1_SetFile(Asn1* asn1, XFILE file);
*/
int wc_Asn1_PrintAll(Asn1* asn1, Asn1PrintOptions* opts, unsigned char* data,
word32 len);

14 changes: 7 additions & 7 deletions doc/dox_comments/header_files/camellia.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@
\sa wc_CamelliaCbcEncrypt
\sa wc_CamelliaCbcDecrypt
*/
int wc_CamelliaSetKey(Camellia* cam,
const byte* key, word32 len, const byte* iv);
int wc_CamelliaSetKey(wc_Camellia* cam, const byte* key, word32 len,
const byte* iv);

/*!
\ingroup Camellia
Expand Down Expand Up @@ -64,7 +64,7 @@ int wc_CamelliaSetKey(Camellia* cam,

\sa wc_CamelliaSetKey
*/
int wc_CamelliaSetIV(Camellia* cam, const byte* iv);
int wc_CamelliaSetIV(wc_Camellia* cam, const byte* iv);

/*!
\ingroup Camellia
Expand Down Expand Up @@ -92,7 +92,7 @@ int wc_CamelliaSetIV(Camellia* cam, const byte* iv);

\sa wc_CamelliaDecryptDirect
*/
int wc_CamelliaEncryptDirect(Camellia* cam, byte* out,
int wc_CamelliaEncryptDirect(wc_Camellia* cam, byte* out,
const byte* in);

/*!
Expand Down Expand Up @@ -122,7 +122,7 @@ int wc_CamelliaEncryptDirect(Camellia* cam, byte* out,

\sa wc_CamelliaEncryptDirect
*/
int wc_CamelliaDecryptDirect(Camellia* cam, byte* out,
int wc_CamelliaDecryptDirect(wc_Camellia* cam, byte* out,
const byte* in);

/*!
Expand Down Expand Up @@ -151,7 +151,7 @@ int wc_CamelliaDecryptDirect(Camellia* cam, byte* out,

\sa wc_CamelliaCbcDecrypt
*/
int wc_CamelliaCbcEncrypt(Camellia* cam,
int wc_CamelliaCbcEncrypt(wc_Camellia* cam,
byte* out, const byte* in, word32 sz);

/*!
Expand Down Expand Up @@ -180,5 +180,5 @@ int wc_CamelliaCbcEncrypt(Camellia* cam,

\sa wc_CamelliaCbcEncrypt
*/
int wc_CamelliaCbcDecrypt(Camellia* cam,
int wc_CamelliaCbcDecrypt(wc_Camellia* cam,
byte* out, const byte* in, word32 sz);
8 changes: 4 additions & 4 deletions doc/dox_comments/header_files/chacha20_poly1305.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@
int wc_ChaCha20Poly1305_Encrypt(
const byte inKey[CHACHA20_POLY1305_AEAD_KEYSIZE],
const byte inIV[CHACHA20_POLY1305_AEAD_IV_SIZE],
const byte* inAAD, const word32 inAADLen,
const byte* inPlaintext, const word32 inPlaintextLen,
const byte* inAAD, word32 inAADLen,
const byte* inPlaintext, word32 inPlaintextLen,
byte* outCiphertext,
byte outAuthTag[CHACHA20_POLY1305_AEAD_AUTHTAG_SIZE]);

Expand Down Expand Up @@ -118,7 +118,7 @@ int wc_ChaCha20Poly1305_Encrypt(
int wc_ChaCha20Poly1305_Decrypt(
const byte inKey[CHACHA20_POLY1305_AEAD_KEYSIZE],
const byte inIV[CHACHA20_POLY1305_AEAD_IV_SIZE],
const byte* inAAD, const word32 inAADLen,
const byte* inCiphertext, const word32 inCiphertextLen,
const byte* inAAD, word32 inAADLen,
const byte* inCiphertext, word32 inCiphertextLen,
const byte inAuthTag[CHACHA20_POLY1305_AEAD_AUTHTAG_SIZE],
byte* outPlaintext);
6 changes: 3 additions & 3 deletions doc/dox_comments/header_files/dh.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ int wc_InitDhKey(DhKey* key);
\sa wc_InitDhKey
*/
void wc_FreeDhKey(DhKey* key);
int wc_FreeDhKey(DhKey* key);

/*!
\ingroup Diffie-Hellman
Expand Down Expand Up @@ -185,7 +185,7 @@ int wc_DhAgree(DhKey* key, byte* agree, word32* agreeSz,
\sa wc_DhSetKey
*/
int wc_DhKeyDecode(const byte* input, word32* inOutIdx, DhKey* key,
word32);
word32 inSz);

/*!
\ingroup Diffie-Hellman
Expand Down Expand Up @@ -396,5 +396,5 @@ int wc_DhSetKey_ex(DhKey* key, const byte* p, word32 pSz,

/*!
\ingroup Diffie-Hellman
*/
*/
int wc_FreeDhKey(DhKey* key);
10 changes: 5 additions & 5 deletions doc/dox_comments/header_files/ecc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -885,7 +885,7 @@ void wc_ecc_del_point(ecc_point* p);
\sa wc_ecc_del_point
*/

int wc_ecc_copy_point(ecc_point* p, ecc_point *r);
int wc_ecc_copy_point(const ecc_point* p, ecc_point *r);

/*!
\ingroup ECC
Expand Down Expand Up @@ -1003,7 +1003,7 @@ int wc_ecc_point_is_at_infinity(ecc_point *p);
\sa none
*/

int wc_ecc_mulmod(mp_int* k, ecc_point *G, ecc_point *R,
int wc_ecc_mulmod(const mp_int* k, ecc_point *G, ecc_point *R,
mp_int* a, mp_int* modulus, int map);

/*!
Expand Down Expand Up @@ -1534,7 +1534,7 @@ int wc_ecc_export_point_der(const int curve_idx, ecc_point* point,
\sa wc_ecc_export_point_der
*/

int wc_ecc_import_point_der(byte* in, word32 inLen, const int curve_idx,
int wc_ecc_import_point_der(const byte* in, word32 inLen, const int curve_idx,
ecc_point* point);

/*!
Expand Down Expand Up @@ -1621,7 +1621,7 @@ int wc_ecc_sig_size_calc(int sz);
\sa wc_ecc_sig_size_calc
*/

int wc_ecc_sig_size(ecc_key* key);
int wc_ecc_sig_size(const ecc_key* key);


/*!
Expand Down Expand Up @@ -1681,7 +1681,7 @@ ecEncCtx* wc_ecc_ctx_new(int flags, WC_RNG* rng);
\sa wc_ecc_ctx_new
*/

void wc_ecc_ctx_free(ecEncCtx*);
void wc_ecc_ctx_free(ecEncCtx* ctx);

/*!
\ingroup ECC
Expand Down
22 changes: 12 additions & 10 deletions doc/dox_comments/header_files/ed448.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,9 @@ int wc_ed448_make_key(WC_RNG* rng, int keysize, ed448_key* key);
\sa wc_ed448_verify_msg
*/

int wc_ed448_sign_msg(const byte* in, word32 inlen, byte* out,
word32 *outlen, ed448_key* key);
int wc_ed448_sign_msg(const byte* in, word32 inLen, byte* out,
word32 *outLen, ed448_key* key,
const byte* context, byte contextLen);

/*!
\ingroup ED448
Expand Down Expand Up @@ -685,7 +686,7 @@ int wc_ed448_import_private_key_ex(const byte* priv, word32 privSz,
\sa wc_ed448_export_private_only
*/

int wc_ed448_export_public(ed448_key* key, byte* out, word32* outLen);
int wc_ed448_export_public(const ed448_key* key, byte* out, word32* outLen);

/*!
\ingroup ED448
Expand Down Expand Up @@ -725,7 +726,8 @@ int wc_ed448_export_public(ed448_key* key, byte* out, word32* outLen);
\sa wc_ed448_import_private_key_ex
*/

int wc_ed448_export_private_only(ed448_key* key, byte* out, word32* outLen);
int wc_ed448_export_private_only(const ed448_key* key, byte* out,
word32* outLen);

/*!
\ingroup ED448
Expand Down Expand Up @@ -768,7 +770,7 @@ int wc_ed448_export_private_only(ed448_key* key, byte* out, word32* outLen);
\sa wc_ed448_export_private_only
*/

int wc_ed448_export_private(ed448_key* key, byte* out, word32* outLen);
int wc_ed448_export_private(const ed448_key* key, byte* out, word32* outLen);

/*!
\ingroup ED448
Expand Down Expand Up @@ -815,7 +817,7 @@ int wc_ed448_export_private(ed448_key* key, byte* out, word32* outLen);
\sa wc_ed448_export_public
*/

int wc_ed448_export_key(ed448_key* key,
int wc_ed448_export_key(const ed448_key* key,
byte* priv, word32 *privSz,
byte* pub, word32 *pubSz);

Expand Down Expand Up @@ -879,7 +881,7 @@ int wc_ed448_check_key(ed448_key* key);
\sa wc_ed448_make_key
*/

int wc_ed448_size(ed448_key* key);
int wc_ed448_size(const ed448_key* key);

/*!
\ingroup ED448
Expand Down Expand Up @@ -908,7 +910,7 @@ int wc_ed448_size(ed448_key* key);
\sa wc_ed448_pub_size
*/

int wc_ed448_priv_size(ed448_key* key);
int wc_ed448_priv_size(const ed448_key* key);

/*!
\ingroup ED448
Expand All @@ -935,7 +937,7 @@ int wc_ed448_priv_size(ed448_key* key);
\sa wc_ed448_priv_size
*/

int wc_ed448_pub_size(ed448_key* key);
int wc_ed448_pub_size(const ed448_key* key);

/*!
\ingroup ED448
Expand Down Expand Up @@ -963,4 +965,4 @@ int wc_ed448_pub_size(ed448_key* key);
\sa wc_ed448_sign_msg
*/

int wc_ed448_sig_size(ed448_key* key);
int wc_ed448_sig_size(const ed448_key* key);
9 changes: 6 additions & 3 deletions doc/dox_comments/header_files/hash.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ int wc_Hash(enum wc_HashType hash_type,
\param data the data to hash
\param len the length of data
\param hash Byte array to hold hash value.
\param hashLen Number of bytes to write to hash.

_Example_
\code
Expand Down Expand Up @@ -365,7 +366,8 @@ int wc_Sha3_512Hash(const byte* data, word32 len, byte* hash);
\sa wc_Shake128_Update
\sa wc_Shake128_Final
*/
int wc_Shake128Hash(const byte* data, word32 len, byte* hash);
int wc_Shake128Hash(const byte* data, word32 len, byte* hash,
word32 hashLen);

/*!
\ingroup SHA
Expand All @@ -380,6 +382,7 @@ int wc_Shake128Hash(const byte* data, word32 len, byte* hash);
\param data the data to hash
\param len the length of data
\param hash Byte array to hold hash value.
\param hashLen Number of bytes to write to hash.

_Example_
\code
Expand All @@ -390,7 +393,7 @@ int wc_Shake128Hash(const byte* data, word32 len, byte* hash);
\sa wc_Shake256_Update
\sa wc_Shake256_Final
*/
int wc_Shake256Hash(const byte* data, word32 len, byte* hash);

int wc_Shake256Hash(const byte* data, word32 len, byte* hash,
word32 hashLen);


6 changes: 3 additions & 3 deletions doc/dox_comments/header_files/md2.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
\sa wc_Md2Update
\sa wc_Md2Final
*/
void wc_InitMd2(Md2*);
void wc_InitMd2(wc_Md2* md2);

/*!
\ingroup MD2
Expand Down Expand Up @@ -57,7 +57,7 @@ void wc_InitMd2(Md2*);
\sa wc_Md2Final
\sa wc_InitMd2
*/
void wc_Md2Update(Md2* md2, const byte* data, word32 len);
void wc_Md2Update(wc_Md2* md2, const byte* data, word32 len);

/*!
\ingroup MD2
Expand Down Expand Up @@ -88,7 +88,7 @@ void wc_Md2Update(Md2* md2, const byte* data, word32 len);
\sa wc_Md2Final
\sa wc_InitMd2
*/
void wc_Md2Final(Md2* md2, byte* hash);
void wc_Md2Final(wc_Md2* md2, byte* hash);

/*!
\ingroup MD2
Expand Down
6 changes: 3 additions & 3 deletions doc/dox_comments/header_files/md4.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
\sa wc_Md4Update
\sa wc_Md4Final
*/
void wc_InitMd4(Md4*);
void wc_InitMd4(wc_Md4* md4);

/*!
\ingroup MD4
Expand Down Expand Up @@ -57,7 +57,7 @@ void wc_InitMd4(Md4*);
\sa wc_Md4Final
\sa wc_InitMd4
*/
void wc_Md4Update(Md4* md4, const byte* data, word32 len);
void wc_Md4Update(wc_Md4* md4, const byte* data, word32 len);

/*!
\ingroup MD4
Expand Down Expand Up @@ -85,4 +85,4 @@ void wc_Md4Update(Md4* md4, const byte* data, word32 len);
\sa wc_Md4Final
\sa wc_InitMd4
*/
void wc_Md4Final(Md4* md4, byte* hash);
void wc_Md4Final(wc_Md4* md4, byte* hash);
4 changes: 2 additions & 2 deletions doc/dox_comments/header_files/md5.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
\sa wc_Md5Update
\sa wc_Md5Final
*/
int wc_InitMd5(wc_Md5*);
int wc_InitMd5(wc_Md5* md5);

/*!
\ingroup MD5
Expand Down Expand Up @@ -148,7 +148,7 @@ int wc_Md5Final(wc_Md5* md5, byte* hash);
\sa wc_Md5Update
\sa wc_Md5Final
*/
void wc_Md5Free(wc_Md5*);
void wc_Md5Free(wc_Md5* md5);

/*!
\ingroup MD5
Expand Down
Loading