commit 185f812c419f1b4f0d10d9787d59cf9f11a2a600
author Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Wed Jan 19 18:05:50 2022 +0100
committer Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Wed Jan 19 18:11:34 2022 +0100
tree 2fea02768d6005934547f075586c60ba7aca6253
parent 6a685753ce8b6b02b67d64b239143bf19eda63c9

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>

include/console.h

diff --git a/include/console.h b/include/console.h
index b182440..ceb733b 100644
--- a/include/console.h
+++ b/include/console.h
@@ -33,7 +33,7 @@
  * Iterates over registered STDIO devices and match them with given @flags
  * and @name.
  *
- * @return pointer to the &struct stdio_dev if found, or NULL otherwise
+ * Return: pointer to the &struct stdio_dev if found, or NULL otherwise
  */
 struct stdio_dev *console_search_dev(int flags, const char *name);
 
@@ -44,7 +44,7 @@
  * This should be called as soon as malloc() is available so that the maximum
  * amount of console output can be recorded.
  *
- * @return 0 if OK, -ENOMEM if out of memory
+ * Return: 0 if OK, -ENOMEM if out of memory
  */
 int console_record_init(void);
 
@@ -60,7 +60,7 @@
  *
  * This should be called to enable the console buffer.
  *
- * @return 0 (always)
+ * Return: 0 (always)
  */
 int console_record_reset_enable(void);
 
@@ -72,7 +72,7 @@
  *
  * @str: Place to put string
  * @maxlen: Maximum length of @str including nul terminator
- * @return length of string returned, or -ENOSPC if the console buffer was
+ * Return: length of string returned, or -ENOSPC if the console buffer was
  *	overflowed by the output
  */
 int console_record_readline(char *str, int maxlen);
@@ -80,7 +80,7 @@
 /**
  * console_record_avail() - Get the number of available bytes in console output
  *
- * @return available bytes (0 if empty)
+ * Return: available bytes (0 if empty)
  */
 int console_record_avail(void);
 
@@ -91,7 +91,7 @@
  * returned if a function calls e.g. `getc()`
  *
  * @str: the string to write
- * @return  the number of bytes added
+ * Return:  the number of bytes added
  */
 int console_in_puts(const char *str);
 #else
@@ -141,7 +141,7 @@
  * This function prints a banner on devices which (we assume) did not receive
  * it before relocation.
  *
- * @return 0 (meaning no errors)
+ * Return: 0 (meaning no errors)
  */
 int console_announce_r(void);