wolfSSL/wolfssl
1
0
Fork 1
mirror of https://github.com/wolfSSL/wolfssl.git synced 2026-07-05 08:20:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix issues in documentation of wc_LoadStaticMemory's return code.

Browse Source
This commit is contained in:
Kareem
2026-02-04 15:25:03 -07:00
parent 59c14cdc6c
commit f94489b66d
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/dox_comments/header_files/memory.h
+6 -4
View File
@@ -376,7 +376,8 @@ int wolfSSL_is_static_memory(WOLFSSL* ssl, WOLFSSL_MEM_CONN_STATS* mem_stats);
buffers to themselves for their lifetime.
WOLFMEM_TRACK_STATS - each SSL keeps track of memory stats while running
\return none This function does not return a value.
\return Returns 0 on success.
\return Returns a non-zero integer on failure.
\param pHint WOLFSSL_HEAP_HINT structure to use
\param buf memory to use for all operations.
@@ -396,7 +397,7 @@ int wolfSSL_is_static_memory(WOLFSSL* ssl, WOLFSSL_MEM_CONN_STATS* mem_stats);
// load in memory for use
ret = wc_LoadStaticMemory(&hint, memory, memorySz, flag, 0);
if (ret != SSL_SUCCESS) {
if (ret) {
// handle error case
}
...
@@ -419,7 +420,8 @@ int wc_LoadStaticMemory(WOLFSSL_HEAP_HINT** pHint, unsigned char* buf,
into functions. This extended version allows for custom bucket sizes and distributions
instead of using the default predefined sizes.
\return none This function does not return a value.
\return Returns 0 on success.
\return Returns a non-zero integer on failure.
\param pHint WOLFSSL_HEAP_HINT handle to initialize
\param listSz number of entries in the size and distribution lists
@@ -447,7 +449,7 @@ int wc_LoadStaticMemory(WOLFSSL_HEAP_HINT** pHint, unsigned char* buf,
ret = wc_LoadStaticMemory_ex(&hint, listSz, sizeList, distList,
memory, memorySz, flag, 0);
if (ret != SSL_SUCCESS) {
if (ret) {
// handle error case
}
...