From 185f812c419f1b4f0d10d9787d59cf9f11a2a600 Mon Sep 17 00:00:00 2001
From: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Date: Wed, 19 Jan 2022 18:05:50 +0100
Subject: 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>
---
 fs/cbfs/cbfs.c | 10 +++++-----
 fs/fat/fat.c   |  8 ++++----
 2 files changed, 9 insertions(+), 9 deletions(-)

(limited to 'fs')

diff --git a/fs/cbfs/cbfs.c b/fs/cbfs/cbfs.c
index 3e905c74e5..714f4baafc 100644
--- a/fs/cbfs/cbfs.c
+++ b/fs/cbfs/cbfs.c
@@ -85,7 +85,7 @@ static void swap_file_header(struct cbfs_fileheader *dest,
  * @node: Node to fill
  * @start: Pointer to the start of the CBFS file in memory
  * @header: Pointer to the header information (in our enddianess)
- * @return 0 if OK, -EBADF if the header is too small
+ * Return: 0 if OK, -EBADF if the header is too small
  */
 static int fill_node(struct cbfs_cachenode *node, void *start,
 		     struct cbfs_fileheader *header)
@@ -142,7 +142,7 @@ static int fill_node(struct cbfs_cachenode *node, void *start,
  * @param used		A pointer to the count of of bytes scanned through,
  *			including the file if one is found.
  *
- * @return 0 if a file is found, -ENOENT if one isn't, -EBADF if a bad header
+ * Return: 0 if a file is found, -ENOENT if one isn't, -EBADF if a bad header
  *	is found.
  */
 static int file_cbfs_next_file(struct cbfs_priv *priv, void *start, int size,
@@ -234,7 +234,7 @@ static int file_cbfs_fill_cache(struct cbfs_priv *priv, int size, int align)
  *
  * @priv: Private data, which is inited by this function
  * @addr: Address of CBFS header in memory-mapped SPI flash
- * @return 0 if OK, -ENXIO if the header is bad
+ * Return: 0 if OK, -ENXIO if the header is bad
  */
 static int load_header(struct cbfs_priv *priv, ulong addr)
 {
@@ -259,7 +259,7 @@ static int load_header(struct cbfs_priv *priv, ulong addr)
  *
  * @priv: Private data, which is inited by this function
  * @end_of_rom: Address of the last byte of the ROM (typically 0xffffffff)
- * @return 0 if OK, -ENXIO if the header is bad
+ * Return: 0 if OK, -ENXIO if the header is bad
  */
 static int file_cbfs_load_header(struct cbfs_priv *priv, ulong end_of_rom)
 {
@@ -279,7 +279,7 @@ static int file_cbfs_load_header(struct cbfs_priv *priv, ulong end_of_rom)
  *
  * @priv: Private data, which is inited by this function
  * @base: Address of the first byte of the ROM (e.g. 0xff000000)
- * @return 0 if OK, -ENXIO if the header is bad
+ * Return: 0 if OK, -ENXIO if the header is bad
  */
 static int cbfs_load_header_ptr(struct cbfs_priv *priv, ulong base)
 {
diff --git a/fs/fat/fat.c b/fs/fat/fat.c
index 65f77c4f75..df9ea2c028 100644
--- a/fs/fat/fat.c
+++ b/fs/fat/fat.c
@@ -735,7 +735,7 @@ static int fat_itr_isdir(fat_itr *itr);
  *
  * @itr: iterator to initialize
  * @fsdata: filesystem data for the partition
- * @return 0 on success, else -errno
+ * Return: 0 on success, else -errno
  */
 static int fat_itr_root(fat_itr *itr, fsdata *fsdata)
 {
@@ -954,7 +954,7 @@ static dir_entry *extract_vfat_name(fat_itr *itr)
  * Must be called once on a new iterator before the cursor is valid.
  *
  * @itr: the iterator to iterate
- * @return boolean, 1 if success or 0 if no more entries in the
+ * Return: boolean, 1 if success or 0 if no more entries in the
  *    current directory
  */
 static int fat_itr_next(fat_itr *itr)
@@ -1024,7 +1024,7 @@ static int fat_itr_next(fat_itr *itr)
  * fat_itr_isdir() - is current cursor position pointing to a directory
  *
  * @itr: the iterator
- * @return true if cursor is at a directory
+ * Return: true if cursor is at a directory
  */
 static int fat_itr_isdir(fat_itr *itr)
 {
@@ -1052,7 +1052,7 @@ static int fat_itr_isdir(fat_itr *itr)
  * @itr: iterator initialized to root
  * @path: the requested path
  * @type: bitmask of allowable file types
- * @return 0 on success or -errno
+ * Return: 0 on success or -errno
  */
 static int fat_itr_resolve(fat_itr *itr, const char *path, unsigned type)
 {
-- 
cgit v1.2.3