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>

1 files changed, 4 insertions, 4 deletions

diff --git a/include/hash.h b/include/hash.h
index cfafbe7..8b3f79e 100644
--- a/include/hash.h
+++ b/include/hash.h
@@ -114,7 +114,7 @@ int hash_command(const char *algo_name, int flags, struct cmd_tbl *cmdtp,
  *			If NULL, then it is assumed that the caller has
  *			allocated enough space for the hash. This is possible
  *			since the caller is selecting the algorithm.
- * @return 0 if ok, -ve on error: -EPROTONOSUPPORT for an unknown algorithm,
+ * Return: 0 if ok, -ve on error: -EPROTONOSUPPORT for an unknown algorithm,
  * -ENOSPC if the output buffer is not large enough.
  */
 int hash_block(const char *algo_name, const void *data, unsigned int len,
@@ -131,7 +131,7 @@ int hash_block(const char *algo_name, const void *data, unsigned int len,
  * @algo_name: Hash algorithm to look up
  * @algop: Pointer to the hash_algo struct if found
  *
- * @return 0 if ok, -EPROTONOSUPPORT for an unknown algorithm.
+ * Return: 0 if ok, -EPROTONOSUPPORT for an unknown algorithm.
  */
 int hash_lookup_algo(const char *algo_name, struct hash_algo **algop);
 
@@ -144,7 +144,7 @@ int hash_lookup_algo(const char *algo_name, struct hash_algo **algop);
  * @algo_name: Hash algorithm to look up
  * @algop: Pointer to the hash_algo struct if found
  *
- * @return 0 if ok, -EPROTONOSUPPORT for an unknown algorithm.
+ * Return: 0 if ok, -EPROTONOSUPPORT for an unknown algorithm.
  */
 int hash_progressive_lookup_algo(const char *algo_name,
 				 struct hash_algo **algop);
@@ -159,7 +159,7 @@ int hash_progressive_lookup_algo(const char *algo_name,
  * @str: Hash string to get parsed
  * @result: Binary array of the parsed hash string
  *
- * @return 0 if ok, -EPROTONOSUPPORT for an unknown algorithm.
+ * Return: 0 if ok, -EPROTONOSUPPORT for an unknown algorithm.
  */
 int hash_parse_string(const char *algo_name, const char *str, uint8_t *result);