summaryrefslogtreecommitdiff
path: root/include/serial.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/serial.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/serial.h')
-rw-r--r--include/serial.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/include/serial.h b/include/serial.h
index 6d1e62c677..19a8c0c67d 100644
--- a/include/serial.h
+++ b/include/serial.h
@@ -293,7 +293,7 @@ struct serial_dev_priv {
*
* @dev: Device pointer
* @serial_config: Returns config information (see SERIAL_... above)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int serial_getconfig(struct udevice *dev, uint *config);
@@ -305,7 +305,7 @@ int serial_getconfig(struct udevice *dev, uint *config);
*
* @dev: Device pointer
* @serial_config: number of bits, parity and number of stopbits to use
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int serial_setconfig(struct udevice *dev, uint config);
@@ -314,7 +314,7 @@ int serial_setconfig(struct udevice *dev, uint config);
*
* @dev: Device pointer
* @info: struct serial_device_info to fill
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int serial_getinfo(struct udevice *dev, struct serial_device_info *info);
@@ -333,7 +333,7 @@ void sh_serial_initialize(void);
* The total size of the output must be less than CONFIG_SYS_PBSIZE.
*
* @fmt: Printf format string, followed by format arguments
- * @return number of characters written
+ * Return: number of characters written
*/
int serial_printf(const char *fmt, ...)
__attribute__ ((format (__printf__, 1, 2)));