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>
diff --git a/include/serial.h b/include/serial.h
index 6d1e62c..19a8c0c 100644
--- a/include/serial.h
+++ b/include/serial.h
@@ -293,7 +293,7 @@
*
* @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 @@
*
* @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 @@
*
* @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 @@
* 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)));