wolfSSL/wolfssl
1
0
Fork 1
mirror of https://github.com/wolfSSL/wolfssl.git synced 2026-01-27 05:42:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix some errors in the doc edits

Browse Source
This commit is contained in:
Andrew Hutchings
2025-12-03 14:56:52 +00:00
parent 026fa2dd4e
commit c4e9ca4eca
4 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -99,6 +99,9 @@ int wc_ed448_make_key(WC_RNG* rng, int keysize, ed448_key* key);
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.
\param [in] context Pointer to the buffer containing the context for which
message is being signed.
\param [in] contextLen Length of the context buffer.
_Example_
\code

7
doc/dox_comments/header_files/memory.h
View File

@@ -47,8 +47,6 @@ void* wolfSSL_Malloc(size_t size, void* heap, int type);
\param ptr pointer to the memory to be freed.
\param heap heap hint to use for memory. Can be NULL
\param type dynamic type (see DYNAMIC_TYPE_ list in types.h)
\param func name of calling function (for allocation tracking)
\param line source line number of call site
_Example_
\code
@@ -56,7 +54,7 @@ void* wolfSSL_Malloc(size_t size, void* heap, int type);
// process data as desired
...
if(tenInts) {
wolfSSL_Free(tenInts);
wolfSSL_Free(tenInts, NULL, DYNAMIC_TYPE_TMP_BUFFER);
}
\endcode
@@ -67,8 +65,7 @@ void* wolfSSL_Malloc(size_t size, void* heap, int type);
\sa XFREE
\sa XREALLOC
*/
void wolfSSL_Free(void *ptr, void* heap, int type, const char* func,
unsigned int line);
void wolfSSL_Free(void *ptr, void* heap, int type);
/*!
\ingroup Memory

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

@@ -24,7 +24,7 @@
\sa wc_FreeNetRandom
*/
int wc_InitNetRandom(const char*, wnr_hmac_key, int);
int wc_InitNetRandom(const char* configFile, wnr_hmac_key hmac_cb, int timeout);
/*!
\ingroup Random

6
doc/dox_comments/header_files/wolfio.h
View File

@@ -115,7 +115,7 @@ int EmbedSend(WOLFSSL* ssl, char* buf, int sz, void* ctx);
\sa wolfSSL_SSLSetIORecv
\sa wolfSSL_dtls_get_current_timeout
*/
int EmbedReceiveFrom(WOLFSSL *ssl, char *buf, int sz, void *ctx);
int EmbedReceiveFrom(WOLFSSL* ssl, char* buf, int sz, void* ctx);
/*!
\brief This function is the send embedded callback.
@@ -189,8 +189,8 @@ int EmbedSendTo(WOLFSSL* ssl, char* buf, int sz, void* ctx);
\sa wolfSSL_CTX_SetGenCookie
*/
int EmbedGenerateCookie(WOLFSSL* ssl, byte *buf,
int sz, void *ctx);
int EmbedGenerateCookie(WOLFSSL* ssl, byte* buf,
int sz, void* ctx);
/*!
\brief This function frees the response buffer.