diff options
| author | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 18:05:50 +0100 |
|---|---|---|
| committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 18:11:34 +0100 |
| commit | 185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch) | |
| tree | 2fea02768d6005934547f075586c60ba7aca6253 /include/mailbox-uclass.h | |
| parent | 6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff) | |
| download | u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.gz | |
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>
Diffstat (limited to 'include/mailbox-uclass.h')
| -rw-r--r-- | include/mailbox-uclass.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/mailbox-uclass.h b/include/mailbox-uclass.h index 3c60c76506..866ca0aa8d 100644 --- a/include/mailbox-uclass.h +++ b/include/mailbox-uclass.h @@ -62,7 +62,7 @@ struct mbox_ops { * * @chan: The channel to send to the message to. * @data: A pointer to the message to send. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int (*send)(struct mbox_chan *chan, const void *data); /** @@ -73,7 +73,7 @@ struct mbox_ops { * * @chan: The channel to receive to the message from. * @data: A pointer to the buffer to hold the received message. - * @return 0 if OK, -ENODATA if no message was available, or a negative + * Return: 0 if OK, -ENODATA if no message was available, or a negative * error code. */ int (*recv)(struct mbox_chan *chan, void *data); |