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

diff --git a/include/sound.h b/include/sound.h
index 71bd850652e..dab9ea186eb 100644
--- a/include/sound.h
+++ b/include/sound.h
@@ -116,7 +116,7 @@ int sound_setup(struct udevice *dev);
  * @dev: Sound device
  * @msecs: Duration of beep in milliseconds
  * @frequency_hz: Frequency of the beep in Hertz
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int sound_beep(struct udevice *dev, int msecs, int frequency_hz);
 
@@ -128,7 +128,7 @@ int sound_beep(struct udevice *dev, int msecs, int frequency_hz);
  *
  * @dev: Sound device
  * @frequency_hz: Beep frequency in hertz
- * @return if OK, -ve on error
+ * Return: if OK, -ve on error
  */
 int sound_start_beep(struct udevice *dev, int frequency_hz);
 
@@ -138,7 +138,7 @@ int sound_start_beep(struct udevice *dev, int frequency_hz);
  * This tells the sound hardware to stop a previously started beep.
  *
  * @dev: Sound device
- * @return if OK, -ve on error
+ * Return: if OK, -ve on error
  */
 int sound_stop_beep(struct udevice *dev);