Browse Source

sandbox: fix documentation of struct host_ops

The documentation of struct host_ops should be Sphinx compliant.

Fixes: 9bd1aa8af2ed ("dm: sandbox: Create a new HOST uclass")
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Heinrich Schuchardt 1 year ago
parent
commit
dd706c83be
1 changed files with 8 additions and 11 deletions
  1. 8 11
      include/sandbox_host.h

+ 8 - 11
include/sandbox_host.h

@@ -23,26 +23,23 @@ struct host_sb_plat {
 
 /**
  * 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 {
-	/*
-	 * attach_file() - Attach a new file to the device
+	/**
+	 * @attach_file: - Attach a new file to the device
 	 *
-	 * @dev: Device to update
-	 * @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.dev: Device to update
+	 * @attach_file.filename: Name of the file, e.g. "/path/to/disk.img"
+	 * @attach_file.Returns: 0 if OK, -EEXIST if a file is already attached, other -ve on
 	 * other error
 	 */
 	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
-	 * Returns: 0 if OK, -ENOENT if no file is attached, other -ve on other
+	 * @detach_file.dev: Device to detach from
+	 * @detach_file.Returns: 0 if OK, -ENOENT if no file is attached, other -ve on other
 	 * error
 	 */
 	 int (*detach_file)(struct udevice *dev);