retention: Fix documentation issue

nordicjm · aescolar · commit 2aa6b81b646e · 2024-07-25T09:25:21.000+02:00
Fixes a minor issue with the return value in the documentation

Signed-off-by: Jamie McCrae &lt;jamie.mccrae@nordicsemi.no&gt;
diff --git a/include/zephyr/retention/blinfo.h b/include/zephyr/retention/blinfo.h
@@ -41,7 +41,7 @@ extern "C" {
  * @param val		Where the return information will be placed.
  * @param val_len_max	The maximum size of the provided buffer.
  *
- * @retval 0		If successful.
+ * @retval >= 0		If successful (contains length of read value)
  * @retval -EOVERFLOW	If the data is too large to fit the supplied buffer.
  * @retval -EIO		If the requested key was not found.
  * @retval -errno	Error code.

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ extern "C" {`
`41`	`41`	`* @param val Where the return information will be placed.`
`42`	`42`	`* @param val_len_max The maximum size of the provided buffer.`
`43`	`43`	`*`
`44`		`- * @retval 0 If successful.`
	`44`	`+ * @retval >= 0 If successful (contains length of read value)`
`45`	`45`	`* @retval -EOVERFLOW If the data is too large to fit the supplied buffer.`
`46`	`46`	`* @retval -EIO If the requested key was not found.`
`47`	`47`	`* @retval -errno Error code.`