docs: fix encrypt key erase return contract

danielinux · danielinux · commit cdf84024faae · 2026-04-09T15:00:09.000+02:00
diff --git a/src/libwolfboot.c b/src/libwolfboot.c
@@ -1676,7 +1676,7 @@ int RAMFUNCTION wolfBoot_get_encrypt_key(uint8_t *k, uint8_t *nonce)
  * This function erases the encryption key and nonce, resetting them to all 0xFF
  * bytes.It ensures that the key and nonce cannot be accessed after erasure.
  *
- * @return 0 if successful.
+ * @return 0 on success, or the underlying flash error code on failure.
  *
  */
 int RAMFUNCTION wolfBoot_erase_encrypt_key(void)

Original file line number	Diff line number	Diff line change
`@@ -1676,7 +1676,7 @@ int RAMFUNCTION wolfBoot_get_encrypt_key(uint8_t k, uint8_t nonce)`
`1676`	`1676`	`* This function erases the encryption key and nonce, resetting them to all 0xFF`
`1677`	`1677`	`* bytes.It ensures that the key and nonce cannot be accessed after erasure.`
`1678`	`1678`	`*`
`1679`		`- * @return 0 if successful.`
	`1679`	`+ * @return 0 on success, or the underlying flash error code on failure.`
`1680`	`1680`	`*`
`1681`	`1681`	`*/`
`1682`	`1682`	`int RAMFUNCTION wolfBoot_erase_encrypt_key(void)`