disk: part_dos: Document part_get_info_extended() helper function

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@gmx.de>
Signed-off-by: Javier Martinez Canillas <javierm@redhat.com>
Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>

diff --git a/disk/part_dos.c b/disk/part_dos.c
index 60c3d677369662a2d6f08db2c4beaf7c57f333d9..a69ad89621060c6e08f7ed006f4e2c35ed29a3ea 100644 (file)
--- 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,