Cyclic0007/wolfssl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix Doxygen parameters

Browse Source
This commit is contained in:
Andrew Hutchings
2025-12-03 15:15:32 +00:00
parent c4e9ca4eca
commit 590a02e541
6 changed files with 90 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

108
doc/dox_comments/header_files/aes.h
View File

@@ -1203,19 +1203,19 @@ int wc_AesSivDecrypt(const byte* key, word32 keySz, const byte* assoc,
\return other negative error values returned if AES or CMAC operations
fail.
\param key buffer containing the key to use
\param keySz length of the key buffer in bytes
\param [in] key buffer containing the key to use
\param [in] keySz length of the key buffer in bytes
\param[out] out buffer to hold the ciphertext. Should be the same length as
the plaintext buffer
\param in plaintext buffer to encrypt
\param inSz length of plaintext buffer
\param nonce the cryptographic nonce to use for EAX operations
\param nonceSz length of nonce buffer in bytes
\param [in] in plaintext buffer to encrypt
\param [in] inSz length of plaintext buffer
\param [in] nonce the cryptographic nonce to use for EAX operations
\param [in] nonceSz length of nonce buffer in bytes
\param[out] authTag pointer to the buffer in which to store the
authentication tag
\param authTagSz length of the desired authentication tag
\param authIn pointer to the buffer containing input data to authenticate
\param authInSz length of the input authentication data
\param [in] authTagSz length of the desired authentication tag
\param [in] authIn pointer to the buffer containing input data to authenticate
\param [in] authInSz length of the input authentication data
_Example_
\code
@@ -1266,19 +1266,19 @@ WOLFSSL_API int wc_AesEaxEncryptAuth(const byte* key, word32 keySz, byte* out,
\return other negative error values returned if AES or CMAC operations
fail.
\param key byte buffer containing the key to use
\param keySz length of the key buffer in bytes
\param [in] key byte buffer containing the key to use
\param [in] keySz length of the key buffer in bytes
\param[out] out buffer to hold the plaintext. Should be the same length as
the input ciphertext buffer
\param in ciphertext buffer to decrypt
\param inSz length of ciphertext buffer
\param nonce the cryptographic nonce to use for EAX operations
\param nonceSz length of nonce buffer in bytes
\param authTag buffer that holds the authentication tag to check the
\param [in] in ciphertext buffer to decrypt
\param [in] inSz length of ciphertext buffer
\param [in] nonce the cryptographic nonce to use for EAX operations
\param [in] nonceSz length of nonce buffer in bytes
\param [in] authTag buffer that holds the authentication tag to check the
authenticity of the data against
\param authTagSz Length of the input authentication tag
\param authIn pointer to the buffer containing input data to authenticate
\param authInSz length of the input authentication data
\param [in] authTagSz Length of the input authentication tag
\param [in] authIn pointer to the buffer containing input data to authenticate
\param [in] authInSz length of the input authentication data
_Example_
\code
@@ -1390,13 +1390,13 @@ WOLFSSL_API int wc_AesEaxInit(AesEax* eax,
\return 0 on success
\return error code on failure
\param eax AES EAX structure holding the context of the AEAD operation
\param [in] eax AES EAX structure holding the context of the AEAD operation
\param[out] out output buffer holding the ciphertext
\param in input buffer holding the plaintext to encrypt
\param inSz size in bytes of the input data buffer
\param authIn (optional) input data to add to the authentication stream
\param [in] in input buffer holding the plaintext to encrypt
\param [in] inSz size in bytes of the input data buffer
\param [in] authIn (optional) input data to add to the authentication stream
This argument should be NULL if not used
\param authInSz size in bytes of the input authentication data
\param [in] authInSz size in bytes of the input authentication data
_Example_
\code
@@ -1455,13 +1455,13 @@ WOLFSSL_API int wc_AesEaxEncryptUpdate(AesEax* eax, byte* out,
\return 0 on success
\return error code on failure
\param eax AES EAX structure holding the context of the AEAD operation
\param [in] eax AES EAX structure holding the context of the AEAD operation
\param[out] out output buffer holding the decrypted plaintext
\param in input buffer holding the ciphertext
\param inSz size in bytes of the input data buffer
\param authIn (optional) input data to add to the authentication stream
\param [in] in input buffer holding the ciphertext
\param [in] inSz size in bytes of the input data buffer
\param [in] authIn (optional) input data to add to the authentication stream
This argument should be NULL if not used
\param authInSz size in bytes of the input authentication data
\param [in] authInSz size in bytes of the input authentication data
_Example_
@@ -1742,13 +1742,13 @@ WOLFSSL_API int wc_AesEaxFree(AesEax* eax);
\return BAD_FUNC_ARG if input arguments are invalid.
\return other negative error codes for encryption failures.
\param key pointer to the AES key used for encryption.
\param keySz size of the AES key in bytes (16, 24, or 32 bytes).
\param [in] key pointer to the AES key used for encryption.
\param [in] keySz size of the AES key in bytes (16, 24, or 32 bytes).
\param[out] out buffer to hold the encrypted ciphertext. Must be at least
the size of the input.
\param in pointer to the plaintext input data to encrypt.
\param inSz size of the plaintext input data in bytes.
\param iv pointer to the initialization vector (IV) used for encryption.
\param [in] in pointer to the plaintext input data to encrypt.
\param [in] inSz size of the plaintext input data in bytes.
\param [in] iv pointer to the initialization vector (IV) used for encryption.
Must be 16 bytes.
_Example_
@@ -1780,13 +1780,13 @@ int wc_AesCtsEncrypt(const byte* key, word32 keySz, byte* out,
\return BAD_FUNC_ARG if input arguments are invalid.
\return other negative error codes for encryption failures.
\param key pointer to the AES key used for encryption.
\param keySz size of the AES key in bytes (16, 24, or 32 bytes).
\param [in] key pointer to the AES key used for encryption.
\param [in] keySz size of the AES key in bytes (16, 24, or 32 bytes).
\param[out] out buffer to hold the encrypted ciphertext. Must be at least
the same size as the input plaintext.
\param in pointer to the plaintext input data to encrypt.
\param inSz size of the plaintext input data in bytes.
\param iv pointer to the initialization vector (IV) used for encryption.
\param [in] in pointer to the plaintext input data to encrypt.
\param [in] inSz size of the plaintext input data in bytes.
\param [in] iv pointer to the initialization vector (IV) used for encryption.
Must be 16 bytes.
_Example_
\code
@@ -1813,13 +1813,13 @@ int wc_AesCtsEncrypt(const byte* key, word32 keySz, byte* out,
\return 0 on successful decryption.
\return BAD_FUNC_ARG if input arguments are invalid.
\return other negative error codes for decryption failures.
\param key pointer to the AES key used for decryption.
\param keySz size of the AES key in bytes (16, 24, or 32 bytes).
\param [in] key pointer to the AES key used for decryption.
\param [in] keySz size of the AES key in bytes (16, 24, or 32 bytes).
\param[out] out buffer to hold the decrypted plaintext. Must be at least
the same size as the input ciphertext.
\param in pointer to the ciphertext input data to decrypt.
\param inSz size of the ciphertext input data in bytes.
\param iv pointer to the initialization vector (IV) used for decryption.
\param [in] in pointer to the ciphertext input data to decrypt.
\param [in] inSz size of the ciphertext input data in bytes.
\param [in] iv pointer to the initialization vector (IV) used for decryption.
Must be 16 bytes.
_Example_
\code
@@ -1845,14 +1845,14 @@ int wc_AesCtsDecrypt(const byte* key, word32 keySz, byte* out,
It processes a chunk of plaintext and stores intermediate data.
\return 0 on successful processing.
\return BAD_FUNC_ARG if input arguments are invalid.
\param aes pointer to the Aes structure holding the context of the operation.
\param [in] aes pointer to the Aes structure holding the context of the operation.
\param[out] out buffer to hold the encrypted ciphertext. Must be large enough
to store the output from this update step.
\param[out] outSz size in bytes of the output data written to the \c out buffer.
On input, it should contain the maximum number of bytes that can
be written to the \c out buffer.
\param in pointer to the plaintext input data to encrypt.
\param inSz size of the plaintext input data in bytes.
On input, it should contain the maximum number of bytes that can
be written to the \c out buffer.
\param [in] in pointer to the plaintext input data to encrypt.
\param [in] inSz size of the plaintext input data in bytes.
_Example_
\code
Aes aes;
@@ -1880,7 +1880,7 @@ int wc_AesCtsEncryptUpdate(Aes* aes, byte* out, word32* outSz,
It processes any remaining plaintext and completes the encryption.
\return 0 on successful encryption completion.
\return BAD_FUNC_ARG if input arguments are invalid.
\param aes pointer to the Aes structure holding the context of the operation.
\param [in] aes pointer to the Aes structure holding the context of the operation.
\param[out] out buffer to hold the final encrypted ciphertext. Must be large
enough to store any remaining ciphertext from this final step.
\param[out] outSz size in bytes of the output data written to the \c out buffer.
@@ -1913,14 +1913,14 @@ int wc_AesCtsEncryptFinal(Aes* aes, byte* out, word32* outSz);
It processes a chunk of ciphertext and stores intermediate data.
\return 0 on successful processing.
\return BAD_FUNC_ARG if input arguments are invalid.
\param aes pointer to the Aes structure holding the context of the operation.
\param [in] aes pointer to the Aes structure holding the context of the operation.
\param[out] out buffer to hold the decrypted plaintext. Must be large enough
to store the output from this update step.
\param[out] outSz size in bytes of the output data written to the \c out buffer.
On input, it should contain the maximum number of bytes that can
be written to the \c out buffer.
\param in pointer to the ciphertext input data to decrypt.
\param inSz size of the ciphertext input data in bytes.
\param [in] in pointer to the ciphertext input data to decrypt.
\param [in] inSz size of the ciphertext input data in bytes.
_Example_
\code
Aes aes;
@@ -1948,7 +1948,7 @@ int wc_AesCtsDecryptUpdate(Aes* aes, byte* out, word32* outSz,
It processes any remaining ciphertext and completes the decryption.
\return 0 on successful decryption completion.
\return BAD_FUNC_ARG if input arguments are invalid.
\param aes pointer to the Aes structure holding the context of the operation.
\param [in] aes pointer to the Aes structure holding the context of the operation.
\param[out] out buffer to hold the final decrypted plaintext. Must be large
enough to store any remaining plaintext from this final step.
\param[out] outSz size in bytes of the output data written to the \c out buffer.

4
doc/dox_comments/header_files/curve25519.h
View File

@@ -108,7 +108,7 @@ int wc_curve25519_shared_secret(curve25519_key* private_key,
the received public key.
\param [out] out Pointer to a buffer in which to store the 32 byte computed
secret key.
\param pin,out] outlen Pointer in which to store the length written to the
\param [in,out] outlen Pointer in which to store the length written to the
output buffer.
\param [in] endian EC25519_BIG_ENDIAN or EC25519_LITTLE_ENDIAN to set which
form to use.
@@ -537,7 +537,7 @@ int wc_curve25519_import_public_ex(const byte* in, word32 inLen,
\return BAD_FUNC_ARG Returned if any of the input parameters are NULL.
\param [in] pub Pointer to the buffer containing the public key to check.
\param [in] pubLen Length of the public key to check.
\param [in] pubSz Length of the public key to check.
\param [in] endian EC25519_BIG_ENDIAN or EC25519_LITTLE_ENDIAN to set which
form to use.

2
doc/dox_comments/header_files/curve448.h
View File

@@ -533,7 +533,7 @@ int wc_curve448_import_public_ex(const byte* in, word32 inLen,
\return BAD_FUNC_ARG Returned if any of the input parameters are NULL.
\param [in] pub Pointer to the buffer containing the public key to check.
\param [in] pubLen Length of the public key to check.
\param [in] pubSz Length of the public key to check.
\param [in] endian EC448_BIG_ENDIAN or EC448_LITTLE_ENDIAN to set which
form to use.

2
doc/dox_comments/header_files/ed25519.h
View File

@@ -201,7 +201,7 @@ int wc_ed25519ctx_sign_msg(const byte* in, word32 inlen, byte* out,
to sign.
\param [in] hashLen Length of the hash of the message to sign.
\param [out] out Buffer in which to store the generated signature.
\param [in,out] outlen Maximum length of the output buffer. Will store the
\param [in,out] outLen Maximum length of the output buffer. Will store the
bytes written to out upon successfully generating a message signature.
\param [in] key Pointer to a private ed25519_key with which to generate the
signature.

24
doc/dox_comments/header_files/ed448.h
View File

@@ -12,10 +12,8 @@
during function execution.
\param [in] key Pointer to the ed448_key for which to generate a key.
\param [out] out Pointer to the buffer in which to store the public key.
\param [in,out] outLen Pointer to a word32 object with the size available
in out. Set with the number of bytes written to out after successfully
exporting the public key.
\param [out] pubKey Pointer to the buffer in which to store the public key.
\param [in] pubKeySz Size of the pubKey buffer in bytes.
_Example_
\code
@@ -93,9 +91,9 @@ int wc_ed448_make_key(WC_RNG* rng, int keysize, ed448_key* key);
function execution.
\param [in] in Pointer to the buffer containing the message to sign.
\param [in] inlen Length of the message to sign.
\param [in] inLen Length of the message to sign.
\param [out] out Buffer in which to store the generated signature.
\param [in,out] outlen Maximum length of the output buffer. Will store the
\param [in,out] outLen Maximum length of the output buffer. Will store the
bytes written to out upon successfully generating a message signature.
\param [in] key Pointer to a private ed448_key with which to generate the
signature.
@@ -149,7 +147,7 @@ int wc_ed448_sign_msg(const byte* in, word32 inLen, byte* out,
to sign.
\param [in] hashLen Length of the hash of the message to sign.
\param [out] out Buffer in which to store the generated signature.
\param [in,out] outlen Maximum length of the output buffer. Will store the
\param [in,out] outLen Maximum length of the output buffer. Will store the
bytes written to out upon successfully generating a message signature.
\param [in] key Pointer to a private ed448_key with which to generate the
signature.
@@ -202,9 +200,9 @@ int wc_ed448ph_sign_hash(const byte* hash, word32 hashLen, byte* out,
function execution.
\param [in] in Pointer to the buffer containing the message to sign.
\param [in] inlen Length of the message to sign.
\param [in] inLen Length of the message to sign.
\param [out] out Buffer in which to store the generated signature.
\param [in,out] outlen Maximum length of the output buffer. Will store the
\param [in,out] outLen Maximum length of the output buffer. Will store the
bytes written to out upon successfully generating a message signature.
\param [in] key Pointer to a private ed448_key with which to generate the
signature.
@@ -261,6 +259,8 @@ int wc_ed448ph_sign_msg(const byte* in, word32 inLen, byte* out,
\param [in] siglen Length of the signature to verify.
\param [in] msg Pointer to the buffer containing the message to verify.
\param [in] msgLen Length of the message to verify.
\param [out] res Pointer to an int that will be set to 1 for a valid
signature or 0 for an invalid signature after verification completes.
\param [in] key Pointer to a public Ed448 key with which to verify the
signature.
\param [in] context Pointer to the buffer containing the context for which
@@ -314,7 +314,9 @@ int wc_ed448_verify_msg(const byte* sig, word32 siglen, const byte* msg,
\param [in] siglen Length of the signature to verify.
\param [in] hash Pointer to the buffer containing the hash of the message
to verify.
\param [in] hashLen Length of the hash to verify.
\param [in] hashlen Length of the hash to verify.
\param [out] res Pointer to an int that will be set to 1 for a valid
signature or 0 for an invalid signature after verification completes.
\param [in] key Pointer to a public Ed448 key with which to verify the
signature.
\param [in] context Pointer to the buffer containing the context for which
@@ -368,6 +370,8 @@ int wc_ed448ph_verify_hash(const byte* sig, word32 siglen, const byte* hash,
\param [in] siglen Length of the signature to verify.
\param [in] msg Pointer to the buffer containing the message to verify.
\param [in] msgLen Length of the message to verify.
\param [out] res Pointer to an int that will be set to 1 for a valid
signature or 0 for an invalid signature after verification completes.
\param [in] key Pointer to a public Ed448 key with which to verify the
signature.
\param [in] context Pointer to the buffer containing the context for which

25
doc/dox_comments/header_files/ssl.h
View File

@@ -15061,8 +15061,18 @@ unsigned int wolfSSL_SESSION_get_max_early_data(const WOLFSSL_SESSION *s);
- wolfSSL_SESSION_get_ex_new_index
- wolfSSL_X509_get_ex_new_index
\param [in] All input parameters are ignored. The callback functions are not
supported with wolfSSL.
\param [in] class_index Identifier for the object class the external data
index applies to. Ignored by wolfSSL.
\param [in] argl Optional long argument passed through for compatibility.
Ignored by wolfSSL.
\param [in] argp Optional pointer argument passed through for compatibility.
Ignored by wolfSSL.
\param [in] new_func Pointer to an external data constructor callback.
Ignored by wolfSSL.
\param [in] dup_func Pointer to an external data duplicate callback.
Ignored by wolfSSL.
\param [in] free_func Pointer to an external data destructor callback.
Ignored by wolfSSL.
\return The new index value to be used with the external data API for this
object class.
@@ -15829,11 +15839,12 @@ void wolfSSL_CTX_set_cert_cb(WOLFSSL_CTX* ctx,
ciphersuites and signature algorithms.
\param [in] ssl The WOLFSSL object to extract the lists from.
\param [out] optional suites Raw and unfiltered list of client ciphersuites
\param [out] optional suiteSz Size of suites in bytes
\param [out] optional hashSigAlgo Raw and unfiltered list of client
signature algorithms
\param [out] optional hashSigAlgoSz Size of hashSigAlgo in bytes
\param [out] suites Raw and unfiltered list of client ciphersuites.
May be NULL if no suites are available.
\param [out] suiteSz Size of suites in bytes.
\param [out] hashSigAlgo Raw and unfiltered list of client signature
algorithms. May be NULL if not provided.
\param [out] hashSigAlgoSz Size of hashSigAlgo in bytes.
\return WOLFSSL_SUCCESS when suites available
\return WOLFSSL_FAILURE when suites not available