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, 5 insertions, 5 deletions

diff --git a/include/mailbox.h b/include/mailbox.h
index 93f4715e16..323b6c2bc5 100644
--- a/include/mailbox.h
+++ b/include/mailbox.h
@@ -76,7 +76,7 @@ struct mbox_chan {
  * @index:	The index of the mailbox channel to request, within the
  *		client's list of channels.
  * @chan	A pointer to a channel object to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
  */
 int mbox_get_by_index(struct udevice *dev, int index, struct mbox_chan *chan);
 
@@ -94,7 +94,7 @@ int mbox_get_by_index(struct udevice *dev, int index, struct mbox_chan *chan);
  * @name:	The name of the mailbox channel to request, within the client's
  *		list of channels.
  * @chan	A pointer to a channel object to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
  */
 int mbox_get_by_name(struct udevice *dev, const char *name,
 		     struct mbox_chan *chan);
@@ -104,7 +104,7 @@ int mbox_get_by_name(struct udevice *dev, const char *name,
  *
  * @chan:	A channel object that was previously successfully requested by
  *		calling mbox_get_by_*().
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
  */
 int mbox_free(struct mbox_chan *chan);
 
@@ -120,7 +120,7 @@ int mbox_free(struct mbox_chan *chan);
  *		the memory region pointed at by @data is determined by the
  *		mailbox provider. Providers that solely transfer notifications
  *		will ignore this parameter.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
  */
 int mbox_send(struct mbox_chan *chan, const void *data);
 
@@ -139,7 +139,7 @@ int mbox_send(struct mbox_chan *chan, const void *data);
  *		notifications will ignore this parameter.
  * @timeout_us:	The maximum time to wait for a message to be available, in
  *		micro-seconds. A value of 0 does not wait at all.
- * @return 0 if OK, -ENODATA if no message was available, or a negative error
+ * Return: 0 if OK, -ENODATA if no message was available, or a negative error
  * code.
  */
 int mbox_recv(struct mbox_chan *chan, void *data, ulong timeout_us);