update function comments

JacobBarthelmeh · JacobBarthelmeh · commit 861f9b4fb286 · 2026-04-23T15:18:34.000-06:00
diff --git a/wolfcrypt/src/wc_xmss.c b/wolfcrypt/src/wc_xmss.c
@@ -119,6 +119,7 @@ static void wc_xmss_digest_free(XmssState* state)
  *
  * @param [in, out] state   XMSS/MT state including digest and parameters.
  * @param [in]      params  Parameters for key.
+ * @param [in]      heap    Dynamic memory hint.
  * @return  0 on success.
  * @return  NOT_COMPILED_IN when digest algorithm not supported.
  * @return  Other negative when digest algorithm initialization failed.
@@ -805,7 +806,7 @@ static WC_INLINE int wc_xmsskey_signupdate(XmssKey* key, byte* sig,
  * Call this before setting the parms of an XMSS key.
  *
  * @param [in] key    The XMSS key to init.
- * @param [in] heap   Unused.
+ * @param [in] heap   Dynamic memory hint used by subsequent allocations.
  * @param [in] devId  Unused.
  *
  * @return  0 on success.

Original file line number	Diff line number	Diff line change
`@@ -119,6 +119,7 @@ static void wc_xmss_digest_free(XmssState* state)`
`119`	`119`	`*`
`120`	`120`	`* @param [in, out] state XMSS/MT state including digest and parameters.`
`121`	`121`	`* @param [in] params Parameters for key.`
	`122`	`+ * @param [in] heap Dynamic memory hint.`
`122`	`123`	`* @return 0 on success.`
`123`	`124`	`* @return NOT_COMPILED_IN when digest algorithm not supported.`
`124`	`125`	`* @return Other negative when digest algorithm initialization failed.`
`@@ -805,7 +806,7 @@ static WC_INLINE int wc_xmsskey_signupdate(XmssKey* key, byte* sig,`
`805`	`806`	`* Call this before setting the parms of an XMSS key.`
`806`	`807`	`*`
`807`	`808`	`* @param [in] key The XMSS key to init.`
`808`		`- * @param [in] heap Unused.`
	`809`	`+ * @param [in] heap Dynamic memory hint used by subsequent allocations.`
`809`	`810`	`* @param [in] devId Unused.`
`810`	`811`	`*`
`811`	`812`	`* @return 0 on success.`