diff options
| author | Heinrich Schuchardt <xypron.glpk@gmx.de> | 2019-07-14 11:52:33 +0200 |
|---|---|---|
| committer | Heinrich Schuchardt <xypron.glpk@gmx.de> | 2019-07-16 22:17:18 +0000 |
| commit | 3f33f30bbadcbf875c3718c7ca6b9ecc9aa56285 (patch) | |
| tree | 99c3469e4c8e1cd7385e172b28f6ca277af5e94b /lib/efi_driver | |
| parent | 9ce912758ae3196aac91adf6a3b86be1f3cf3af3 (diff) | |
efi_driver: use Sphinx style comments
Use Sphinx style comments for describing function parameters.
Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Diffstat (limited to 'lib/efi_driver')
| -rw-r--r-- | lib/efi_driver/efi_block_device.c | 39 |
1 files changed, 20 insertions, 19 deletions
diff --git a/lib/efi_driver/efi_block_device.c b/lib/efi_driver/efi_block_device.c index 3f147cf608..cf02341931 100644 --- a/lib/efi_driver/efi_block_device.c +++ b/lib/efi_driver/efi_block_device.c @@ -43,14 +43,14 @@ struct efi_blk_platdata { struct efi_block_io *io; }; -/* +/** * Read from block device * - * @dev device - * @blknr first block to be read - * @blkcnt number of blocks to read - * @buffer output buffer - * @return number of blocks transferred + * @dev: device + * @blknr: first block to be read + * @blkcnt: number of blocks to read + * @buffer: output buffer + * Return: number of blocks transferred */ static ulong efi_bl_read(struct udevice *dev, lbaint_t blknr, lbaint_t blkcnt, void *buffer) @@ -72,14 +72,14 @@ static ulong efi_bl_read(struct udevice *dev, lbaint_t blknr, lbaint_t blkcnt, return blkcnt; } -/* +/** * Write to block device * - * @dev device - * @blknr first block to be write - * @blkcnt number of blocks to write - * @buffer input buffer - * @return number of blocks transferred + * @dev: device + * @blknr: first block to be write + * @blkcnt: number of blocks to write + * @buffer: input buffer + * Return: number of blocks transferred */ static ulong efi_bl_write(struct udevice *dev, lbaint_t blknr, lbaint_t blkcnt, const void *buffer) @@ -102,11 +102,12 @@ static ulong efi_bl_write(struct udevice *dev, lbaint_t blknr, lbaint_t blkcnt, return blkcnt; } -/* +/** * Create partions for the block device. * - * @handle EFI handle of the block device - * @dev udevice of the block device + * @handle: EFI handle of the block device + * @dev: udevice of the block device + * Return: number of partitions created */ static int efi_bl_bind_partitions(efi_handle_t handle, struct udevice *dev) { @@ -120,12 +121,12 @@ static int efi_bl_bind_partitions(efi_handle_t handle, struct udevice *dev) desc->devnum, dev->name); } -/* +/** * Create a block device for a handle * - * @handle handle - * @interface block io protocol - * @return 0 = success + * @handle: handle + * @interface: block io protocol + * Return: 0 = success */ static int efi_bl_bind(efi_handle_t handle, void *interface) { |