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/video_console.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_console.h')
-rw-r--r-- | include/video_console.h | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/include/video_console.h b/include/video_console.h index 06b798ef10c..5921767fbf0 100644 --- a/include/video_console.h +++ b/include/video_console.h @@ -170,7 +170,7 @@ struct vidconsole_ops { * is the X position multipled by VID_FRAC_DIV. * @y: Pixel Y position (0=top-most pixel) * @ch: Character to write - * @return number of fractional pixels that the cursor should move, + * Return: number of fractional pixels that the cursor should move, * if all is OK, -EAGAIN if we ran out of space on this line, other -ve * on error */ @@ -183,7 +183,7 @@ int vidconsole_putc_xy(struct udevice *dev, uint x, uint y, char ch); * @rowdst: Destination text row (0=top) * @rowsrc: Source start text row * @count: Number of text rows to move - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int vidconsole_move_rows(struct udevice *dev, uint rowdst, uint rowsrc, uint count); @@ -196,7 +196,7 @@ int vidconsole_move_rows(struct udevice *dev, uint rowdst, uint rowsrc, * @dev: Device to adjust * @row: Text row to adjust (0=top) * @clr: Raw colour (pixel value) to write to each pixel - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int vidconsole_set_row(struct udevice *dev, uint row, int clr); @@ -212,7 +212,7 @@ int vidconsole_set_row(struct udevice *dev, uint row, int clr); * * @dev: Device to adjust * @ch: Character to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int vidconsole_put_char(struct udevice *dev, char ch); @@ -228,7 +228,7 @@ int vidconsole_put_char(struct udevice *dev, char ch); * * @dev: Device to adjust * @str: String to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int vidconsole_put_string(struct udevice *dev, const char *str); @@ -238,7 +238,7 @@ int vidconsole_put_string(struct udevice *dev, const char *str); * @dev: Device to adjust * @col: New cursor text column * @row: New cursor text row - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ void vidconsole_position_cursor(struct udevice *dev, unsigned col, unsigned row); @@ -252,7 +252,7 @@ void vidconsole_position_cursor(struct udevice *dev, unsigned col, * * @priv private data of the console device * @idx color index - * @return color value + * Return: color value */ u32 vid_console_color(struct video_priv *priv, unsigned int idx); @@ -268,7 +268,7 @@ u32 vid_console_color(struct video_priv *priv, unsigned int idx); * @dev: Vidconsole device being updated * @from: Start/end address within the framebuffer (->fb) * @to: Other address within the frame buffer - * @return 0 if OK, -EFAULT if the start address is before the start of the + * Return: 0 if OK, -EFAULT if the start address is before the start of the * frame buffer start */ int vidconsole_sync_copy(struct udevice *dev, void *from, void *to); @@ -283,7 +283,7 @@ int vidconsole_sync_copy(struct udevice *dev, void *from, void *to); * @dst: Destination address within the framebuffer (->fb) * @src: Source address within the framebuffer (->fb) * @size: Number of bytes to transfer - * @return 0 if OK, -EFAULT if the start address is before the start of the + * Return: 0 if OK, -EFAULT if the start address is before the start of the * frame buffer start */ int vidconsole_memmove(struct udevice *dev, void *dst, const void *src, |