update function comments

JacobBarthelmeh · JacobBarthelmeh · commit 5b4ad8690ec7 · 2026-05-01T09:43:52.000-06:00
diff --git a/wolfcrypt/src/wc_xmss.c b/wolfcrypt/src/wc_xmss.c
@@ -124,6 +124,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.
@@ -810,7 +811,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
`@@ -124,6 +124,7 @@ static void wc_xmss_digest_free(XmssState* state)`
`124`	`124`	`*`
`125`	`125`	`* @param [in, out] state XMSS/MT state including digest and parameters.`
`126`	`126`	`* @param [in] params Parameters for key.`
	`127`	`+ * @param [in] heap Dynamic memory hint.`
`127`	`128`	`* @return 0 on success.`
`128`	`129`	`* @return NOT_COMPILED_IN when digest algorithm not supported.`
`129`	`130`	`* @return Other negative when digest algorithm initialization failed.`
`@@ -810,7 +811,7 @@ static WC_INLINE int wc_xmsskey_signupdate(XmssKey* key, byte* sig,`
`810`	`811`	`* Call this before setting the parms of an XMSS key.`
`811`	`812`	`*`
`812`	`813`	`* @param [in] key The XMSS key to init.`
`813`		`- * @param [in] heap Unused.`
	`814`	`+ * @param [in] heap Dynamic memory hint used by subsequent allocations.`
`814`	`815`	`* @param [in] devId Unused.`
`815`	`816`	`*`
`816`	`817`	`* @return 0 on success.`