[PATCH -next] block: Fix some kernel-doc comments

Yang Li
2024-03-08T08:19:50Z

This commit adds kernel-doc style comments with complete parameter
descriptions for the functions read_lba, alloc_pvd, and alloc_lvn.

Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
block/partitions/aix.c | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/block/partitions/aix.c b/block/partitions/aix.c
index 85f4b967565e..83e73bcda86c 100644
--- a/block/partitions/aix.c
+++ b/block/partitions/aix.c
@@ -68,10 +68,10 @@ struct pvd {

/**
* read_lba(): Read bytes from disk, starting at given LBA
- * @state
- * @lba
- * @buffer
- * @count
+ * @state: disk parsed partitions
+ * @lba: the Logical Block Address of the partition table
+ * @buffer: destination buffer
+ * @count: bytes to read
*
* Description: Reads @count bytes from @state->disk into @buffer.
* Returns number of bytes read on success, 0 on error.
@@ -103,8 +103,8 @@ static size_t read_lba(struct parsed_partitions *state, u64 lba, u8 *buffer,

/**
* alloc_pvd(): reads physical volume descriptor
- * @state
- * @lba
+ * @state: disk parsed partitions
+ * @lba: the Logical Block Address of the partition table
*
* Description: Returns pvd on success, NULL on error.
* Allocates space for pvd and fill it with disk blocks at @lba
@@ -128,8 +128,8 @@ static struct pvd *alloc_pvd(struct parsed_partitions *state, u32 lba)

/**
* alloc_lvn(): reads logical volume names
- * @state
- * @lba
+ * @state: disk parsed partitions
+ * @lba: the Logical Block Address of the partition table
*
* Description: Returns lvn on success, NULL on error.
* Allocates space for lvn and fill it with disk blocks at @lba
--
2.20.1.7.g153144c