doc: replace @return by Return:

Sphinx expects Return: and not @return to indicate a return value.

find . -name '*.c' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;

find . -name '*.h' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>

1 files changed, 13 insertions, 13 deletions

diff --git a/include/virtio.h b/include/virtio.h
index 34e2bfdcdd3..062a24630ce 100644
--- a/include/virtio.h
+++ b/include/virtio.h
@@ -228,7 +228,7 @@ struct virtio_dev_priv {
  * @offset:	the offset of the configuration field
  * @buf:	the buffer to write the field value into
  * @len:	the length of the buffer
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int virtio_get_config(struct udevice *vdev, unsigned int offset,
 		      void *buf, unsigned int len);
@@ -240,7 +240,7 @@ int virtio_get_config(struct udevice *vdev, unsigned int offset,
  * @offset:	the offset of the configuration field
  * @buf:	the buffer to read the field value from
  * @len:	the length of the buffer
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int virtio_set_config(struct udevice *vdev, unsigned int offset,
 		      void *buf, unsigned int len);
@@ -250,7 +250,7 @@ int virtio_set_config(struct udevice *vdev, unsigned int offset,
  *
  * @vdev:	the real virtio device
  * @counter:	the returned config generation counter
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int virtio_generation(struct udevice *vdev, u32 *counter);
 
@@ -259,7 +259,7 @@ int virtio_generation(struct udevice *vdev, u32 *counter);
  *
  * @vdev:	the real virtio device
  * @status:	the returned status byte
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int virtio_get_status(struct udevice *vdev, u8 *status);
 
@@ -268,7 +268,7 @@ int virtio_get_status(struct udevice *vdev, u8 *status);
  *
  * @vdev:	the real virtio device
  * @status:	the new status byte
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int virtio_set_status(struct udevice *vdev, u8 status);
 
@@ -276,7 +276,7 @@ int virtio_set_status(struct udevice *vdev, u8 status);
  * virtio_reset() - reset the device
  *
  * @vdev:	the real virtio device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int virtio_reset(struct udevice *vdev);
 
@@ -285,7 +285,7 @@ int virtio_reset(struct udevice *vdev);
  *
  * @vdev:	the real virtio device
  * @features:	the first 32 feature bits (all we currently need)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int virtio_get_features(struct udevice *vdev, u64 *features);
 
@@ -293,7 +293,7 @@ int virtio_get_features(struct udevice *vdev, u64 *features);
  * virtio_set_features() - confirm what device features we'll be using
  *
  * @vdev:	the real virtio device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int virtio_set_features(struct udevice *vdev);
 
@@ -303,7 +303,7 @@ int virtio_set_features(struct udevice *vdev);
  * @vdev:	the real virtio device
  * @nvqs:	the number of virtqueues to find
  * @vqs:	on success, includes new virtqueues
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int virtio_find_vqs(struct udevice *vdev, unsigned int nvqs,
 		    struct virtqueue *vqs[]);
@@ -312,7 +312,7 @@ int virtio_find_vqs(struct udevice *vdev, unsigned int nvqs,
  * virtio_del_vqs() - free virtqueues found by find_vqs()
  *
  * @vdev:	the real virtio device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int virtio_del_vqs(struct udevice *vdev);
 
@@ -321,7 +321,7 @@ int virtio_del_vqs(struct udevice *vdev);
  *
  * @vdev:	the real virtio device
  * @vq:		virtqueue to process
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int virtio_notify(struct udevice *vdev, struct virtqueue *vq);
 
@@ -337,7 +337,7 @@ void virtio_add_status(struct udevice *vdev, u8 status);
  * virtio_finalize_features() - helper to finalize features
  *
  * @vdev:	the real virtio device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int virtio_finalize_features(struct udevice *vdev);
 
@@ -366,7 +366,7 @@ void virtio_driver_features_init(struct virtio_dev_priv *priv,
 /**
  * virtio_init() - helper to enumerate all known virtio devices
  *
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int virtio_init(void);