leandrof/u-boot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

sandbox: fix documentation of struct host_ops

Browse Source 
The documentation of struct host_ops should be Sphinx compliant.

Fixes: 9bd1aa8af2 ("dm: sandbox: Create a new HOST uclass")
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
This commit is contained in:
Heinrich Schuchardt 2022-11-14 10:16:02 +01:00
parent a8a0fc4628
commit dd706c83be
1 changed files with 8 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
include/sandbox_host.h
View File

@ -23,26 +23,23 @@ struct host_sb_plat {
/** /**
* struct host_ops - operations supported by UCLASS_HOST * struct host_ops - operations supported by UCLASS_HOST
*
* @attach_file: Attach a new file to a device
* @detach_file: Detach a file from a device
*/ */
struct host_ops { struct host_ops {
/* /**
* attach_file() - Attach a new file to the device * @attach_file: - Attach a new file to the device
* *
* @dev: Device to update * @attach_file.dev: Device to update
* @filename: Name of the file, e.g. "/path/to/disk.img" * @attach_file.filename: Name of the file, e.g. "/path/to/disk.img"
* Returns: 0 if OK, -EEXIST if a file is already attached, other -ve on * @attach_file.Returns: 0 if OK, -EEXIST if a file is already attached, other -ve on
* other error * other error
*/ */
int (*attach_file)(struct udevice *dev, const char *filename); int (*attach_file)(struct udevice *dev, const char *filename);
/** /**
* detach_file() - Detach a file from the device * @detach_file: - Detach a file from the device
* *
* @dev: Device to detach from * @detach_file.dev: Device to detach from
* Returns: 0 if OK, -ENOENT if no file is attached, other -ve on other * @detach_file.Returns: 0 if OK, -ENOENT if no file is attached, other -ve on other
* error * error
*/ */
int (*detach_file)(struct udevice *dev); int (*detach_file)(struct udevice *dev);