summaryrefslogtreecommitdiff
path: root/include/video_osd.h
diff options
context:
space:
mode:
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 18:05:50 +0100
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 18:11:34 +0100
commit185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch)
tree2fea02768d6005934547f075586c60ba7aca6253 /include/video_osd.h
parent6a685753ce8b6b02b67d64b239143bf19eda63c9 (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_osd.h')
-rw-r--r--include/video_osd.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/include/video_osd.h b/include/video_osd.h
index 01ac94b425c..dc60bafa8a6 100644
--- a/include/video_osd.h
+++ b/include/video_osd.h
@@ -125,7 +125,7 @@ struct video_osd_ops {
* @dev: OSD instance to query.
* @info: Pointer to a structure that takes the information read from the
* OSD instance.
- * @return 0 if OK, -ve on error.
+ * Return: 0 if OK, -ve on error.
*/
int video_osd_get_info(struct udevice *dev, struct video_osd_info *info);
@@ -155,7 +155,7 @@ int video_osd_get_info(struct udevice *dev, struct video_osd_info *info);
* coordinate on the OSD screen.
* @buflen: Length of the data in the passed buffer (in byte).
* @count: Write count many repetitions of the given text data
- * @return 0 if OK, -ve on error.
+ * Return: 0 if OK, -ve on error.
*/
int video_osd_set_mem(struct udevice *dev, uint col, uint row, u8 *buf,
size_t buflen, uint count);
@@ -167,7 +167,7 @@ int video_osd_set_mem(struct udevice *dev, uint col, uint row, u8 *buf,
* @dev: OSD instance to write to.
* @col The number of characters in the window's columns
* @row The number of characters in the window's rows
- * @return 0 if OK, -ve on error.
+ * Return: 0 if OK, -ve on error.
*/
int video_osd_set_size(struct udevice *dev, uint col, uint row);
@@ -184,7 +184,7 @@ int video_osd_set_size(struct udevice *dev, uint col, uint row);
* interpretation of the value is driver-specific, and possible
* values should be defined e.g. in a driver include file.
* @text: The string data that should be printed on the OSD
- * @return 0 if OK, -ve on error.
+ * Return: 0 if OK, -ve on error.
*/
int video_osd_print(struct udevice *dev, uint col, uint row, ulong color,
char *text);