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/video_bridge.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/video_bridge.h')
-rw-r--r-- | include/video_bridge.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/include/video_bridge.h b/include/video_bridge.h index 22e93dbb53..3b429eac57 100644 --- a/include/video_bridge.h +++ b/include/video_bridge.h @@ -70,7 +70,7 @@ struct video_bridge_ops { /** * video_bridge_attach() - attach a video bridge * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int video_bridge_attach(struct udevice *dev); @@ -78,7 +78,7 @@ int video_bridge_attach(struct udevice *dev); * video_bridge_set_backlight() - Set the backlight brightness * * @percent: brightness percentage (0=off, 100=full brightness) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int video_bridge_set_backlight(struct udevice *dev, int percent); @@ -94,7 +94,7 @@ int video_bridge_set_active(struct udevice *dev, bool active); * check_attached() - check if a bridge is correctly attached * * @dev: Device to check - * @return 0 if attached, -EENOTCONN if not, or other -ve error + * Return: 0 if attached, -EENOTCONN if not, or other -ve error */ int video_bridge_check_attached(struct udevice *dev); @@ -104,7 +104,7 @@ int video_bridge_check_attached(struct udevice *dev); * @dev: Device to read from * @buf: Buffer to read into * @buf_size: Buffer size - * @return number of bytes read, <=0 for error + * Return: number of bytes read, <=0 for error */ int video_bridge_read_edid(struct udevice *dev, u8 *buf, int buf_size); |