[PATCH v2 4/7] disk: part_dos: Document part_get_info_extended() helper function

[Javier Martinez Canillas]

The function receives many parameters but these are not documented.
Add a description for these to make it easier to follow what it does.

Suggested-by: Heinrich Schuchardt <xypron.glpk at gmx.de>
Signed-off-by: Javier Martinez Canillas <javierm at redhat.com>
---

(no changes since v1)

 disk/part_dos.c | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/disk/part_dos.c b/disk/part_dos.c
index 60c3d6773696..a69ad8962106 100644
--- a/disk/part_dos.c
+++ b/disk/part_dos.c
@@ -196,7 +196,18 @@ static void print_partition_extended(struct blk_desc *desc,
 	return;
 }
 
-/*  Print a partition that is relative to its Extended partition table
+/**
+ * part_get_info_extended() - get partition info for a DOS partition
+ *
+ * @desc:		Block device descriptor
+ * @ext_part_sector:	Partition table sector
+ * @relative:		Relative offset for the partition
+ * @part_num:		Current partition number
+ * @which_part:		Target partition number
+ * @info:		Returns a pointer to the partition info
+ * @disksig:		Disk signature
+ *
+ * Return:		0 on success, negative on error
  */
 static int part_get_info_extended(struct blk_desc *desc,
 				  lbaint_t ext_part_sector, lbaint_t relative,
-- 
2.53.0