block: Add parameter descriptions to kernel-doc
PATCH 1/1 block: Add parameter descriptions to kernel-doc
This patch enhances the kernel documentation for the some functions by providing detailed descriptions of its parameters.
Signed-off-by Yang Li <[email protected]>
--- block/partitions/aix.c | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-)
block/partitions/aix.c +11 -8
@@ -68,10 +68,11 @@ struct pvd {/** * read_lba(): Read bytes from disk, starting at given LBA -* @state -* @lba -* @buffer -* @count +* @state: pointer to a parsed_partitions structure which holds the state +* including details about the partitions on the disk. +* @lba: logical block address from where the read operation should start on the disk. +* @buffer: pointer to a buffer where the data read from the disk will be stored. +* @count: number of bytes to be read from the disk. * * Description: Reads @count bytes from @state->disk into @buffer. * Returns number of bytes read on success, 0 on error.
@@ -103,8 +104,9 @@ static size_t read_lba(struct parsed_partitions *state, u64 lba, u8 *buffer,/** * alloc_pvd(): reads physical volume descriptor -* @state -* @lba +* @state: pointer to a parsed_partitions structure which holds the state +* including details about the partitions on the disk. +* @lba: logical block address where the physical volume descriptor is located. * * Description: Returns pvd on success, NULL on error. * Allocates space for pvd and fill it with disk blocks at @lba
@@ -128,8 +130,9 @@ static struct pvd *alloc_pvd(struct parsed_partitions *state, u32 lba)/** * alloc_lvn(): reads logical volume names -* @state -* @lba +* @state: pointer to a parsed_partitions structure which holds the state +* including details about the partitions on the disk. +* @lba: logical block address where the physical volume descriptor is located. * * Description: Returns lvn on success, NULL on error. * Allocates space for lvn and fill it with disk blocks at @lba
Signature · 1 line
2.20.1.7.g153144c