diff options
author | Heinrich Schuchardt | 2022-01-19 18:05:50 +0100 |
---|---|---|
committer | Heinrich Schuchardt | 2022-01-19 18:11:34 +0100 |
commit | 185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch) | |
tree | 2fea02768d6005934547f075586c60ba7aca6253 /include/mailbox.h | |
parent | 6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff) |
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.h')
-rw-r--r-- | include/mailbox.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/include/mailbox.h b/include/mailbox.h index 93f4715e169..323b6c2bc5d 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); |