summaryrefslogtreecommitdiff
path: root/include/display.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/display.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/display.h')
-rw-r--r--include/display.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/include/display.h b/include/display.h
index 66294616ea..3d01217644 100644
--- a/include/display.h
+++ b/include/display.h
@@ -27,7 +27,7 @@ struct display_plat {
* display_read_timing() - Read timing information
*
* @dev: Device to read from
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int display_read_timing(struct udevice *dev, struct display_timing *timing);
@@ -37,7 +37,7 @@ int display_read_timing(struct udevice *dev, struct display_timing *timing);
* @dev: Device to enable
* @panel_bpp: Number of bits per pixel for panel
* @timing: Display timings
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int display_enable(struct udevice *dev, int panel_bpp,
const struct display_timing *timing);
@@ -45,7 +45,7 @@ int display_enable(struct udevice *dev, int panel_bpp,
/**
* display_in_use() - Check if a display is in use by any device
*
- * @return true if the device is in use (display_enable() has been called
+ * Return: true if the device is in use (display_enable() has been called
* successfully), else false
*/
bool display_in_use(struct udevice *dev);