summaryrefslogtreecommitdiff
path: root/include/sound.h
diff options
context:
space:
mode:
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 20:05:50 +0300
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 20:11:34 +0300
commit185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch)
tree2fea02768d6005934547f075586c60ba7aca6253 /include/sound.h
parent6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff)
downloadu-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.xz
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/sound.h')
-rw-r--r--include/sound.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/include/sound.h b/include/sound.h
index 71bd850652..dab9ea186e 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);