diff mbox series

[libubootenv] doxygen: fix libuboot_open/close return value description

Message ID YSe7UuiJOqj5ZQ9J@jan-lenovo
State Accepted
Headers show
Series [libubootenv] doxygen: fix libuboot_open/close return value description | expand

Commit Message

Jan Havran Aug. 26, 2021, 4:03 p.m. UTC
Signed-off-by: Jan Havran <jan.havran@audified.com>
---
 src/libuboot.h | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

Comments

Stefano Babic Aug. 26, 2021, 7:19 p.m. UTC | #1
Hi Jan,

On 26.08.21 18:03, Jan Havran wrote:
> Signed-off-by: Jan Havran <jan.havran@audified.com>
> ---
>   src/libuboot.h | 3 +--
>   1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/src/libuboot.h b/src/libuboot.h
> index bfcaeb1..88f0558 100644
> --- a/src/libuboot.h
> +++ b/src/libuboot.h
> @@ -94,7 +94,7 @@ void libuboot_exit(struct uboot_ctx *ctx);
>   /** @brief Load an environment
>    *
>    * @param[in] ctx libuboot context
> - * @return 0 in case of success
> + * @return 0 in case of success, else negative value
>    */
>   int libuboot_open(struct uboot_ctx *ctx);
>   
> @@ -105,7 +105,6 @@ int libuboot_open(struct uboot_ctx *ctx);
>    * libuboot_open() again.
>    *
>    * @param[in] ctx libuboot context
> - * @return 0 in case of success
>    */
>   void libuboot_close(struct uboot_ctx *ctx);
>   
> 

Applied to -master, thanks !

Best regards,
Stefano Babic
diff mbox series

Patch

diff --git a/src/libuboot.h b/src/libuboot.h
index bfcaeb1..88f0558 100644
--- a/src/libuboot.h
+++ b/src/libuboot.h
@@ -94,7 +94,7 @@  void libuboot_exit(struct uboot_ctx *ctx);
 /** @brief Load an environment
  *
  * @param[in] ctx libuboot context
- * @return 0 in case of success
+ * @return 0 in case of success, else negative value
  */
 int libuboot_open(struct uboot_ctx *ctx);
 
@@ -105,7 +105,6 @@  int libuboot_open(struct uboot_ctx *ctx);
  * libuboot_open() again.
  *
  * @param[in] ctx libuboot context
- * @return 0 in case of success
  */
 void libuboot_close(struct uboot_ctx *ctx);