From: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Date: Tue, 16 Jan 2024 14:00:20 +0000 (+0100)
Subject: part: correct documentation of part_get_bootable()
X-Git-Url: http://git.dujemihanovic.xyz/posts?a=commitdiff_plain;h=e75e4cf5d91012fa8af327177a7927daabfcf931;p=u-boot.git

part: correct documentation of part_get_bootable()

We have to use 'Return:' to render the description of the return value in
the HTML documentation.

Fixes: f55aa4454ac3 ("part: Add a fallback for part_get_bootable()")
Fixes: dcffa4428d03 ("part: Add a function to find the first bootable partition")
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---

diff --git a/include/part.h b/include/part.h
index db34bc6bb7..32ee404885 100644
--- a/include/part.h
+++ b/include/part.h
@@ -685,8 +685,8 @@ int part_get_type_by_name(const char *name);
 /**
  * part_get_bootable() - Find the first bootable partition
  *
- * @desc: Block-device descriptor
- * @return first bootable partition, or 0 if there is none
+ * @desc:	Block-device descriptor
+ * Return:	first bootable partition, or 0 if there is none
  */
 int part_get_bootable(struct blk_desc *desc);