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/display_options.h b/include/display_options.h
index 43810cb..33fcbb8 100644
--- a/include/display_options.h
+++ b/include/display_options.h
@@ -66,7 +66,7 @@
* @linelen: Number of values to print per line; specify 0 for default length
* @out: Output buffer to hold the dump
* @size: Size of output buffer in bytes
- * @return number of bytes processed, if OK, -ENOSPC if buffer too small
+ * Return: number of bytes processed, if OK, -ENOSPC if buffer too small
*
*/
int hexdump_line(ulong addr, const void *data, uint width, uint count,
@@ -91,7 +91,7 @@
* @newlines: true to include two newlines at the start
* @buf: place to put string
* @size: Size of buf (string is truncated to fit)
- * @return buf
+ * Return: buf
*/
char *display_options_get_banner(bool newlines, char *buf, int size);