From f94489b66d39b817c4a9701edaa5d58879b2e29a Mon Sep 17 00:00:00 2001 From: Kareem Date: Wed, 4 Feb 2026 15:25:03 -0700 Subject: [PATCH] Fix issues in documentation of wc_LoadStaticMemory's return code. --- doc/dox_comments/header_files/memory.h | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/dox_comments/header_files/memory.h b/doc/dox_comments/header_files/memory.h index fe18397db1..b5430758a3 100644 --- a/doc/dox_comments/header_files/memory.h +++ b/doc/dox_comments/header_files/memory.h @@ -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 } ...