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/hwspinlock.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/hwspinlock.h')
-rw-r--r-- | include/hwspinlock.h | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/include/hwspinlock.h b/include/hwspinlock.h index 99389c13c24..d8556c0b4b4 100644 --- a/include/hwspinlock.h +++ b/include/hwspinlock.h @@ -39,7 +39,7 @@ struct hwspinlock { * @index: The index of the hardware spinlock to request, within the * client's list of hardware spinlock. * @hws: A pointer to a hardware spinlock struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int hwspinlock_get_by_index(struct udevice *dev, int index, struct hwspinlock *hws); |