diff options
author | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 18:05:50 +0100 |
---|---|---|
committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 18:11:34 +0100 |
commit | 185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch) | |
tree | 2fea02768d6005934547f075586c60ba7aca6253 /include/fs.h | |
parent | 6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff) | |
download | u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.gz u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.bz2 u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.zip |
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>
Diffstat (limited to 'include/fs.h')
-rw-r--r-- | include/fs.h | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/include/fs.h b/include/fs.h index 1c79e299fd..c8df3886ac 100644 --- a/include/fs.h +++ b/include/fs.h @@ -27,7 +27,7 @@ struct blk_desc; * @flag: Command flags (CMD_FLAG_...) * @argc: Number of arguments * @argv: List of arguments - * @return result (see enum command_ret_t) + * Return: result (see enum command_ret_t) */ int do_fat_fsload(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); @@ -39,7 +39,7 @@ int do_fat_fsload(struct cmd_tbl *cmdtp, int flag, int argc, * @flag: Command flags (CMD_FLAG_...) * @argc: Number of arguments * @argv: List of arguments - * @return result (see enum command_ret_t) + * Return: result (see enum command_ret_t) */ int do_ext2load(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); @@ -118,7 +118,7 @@ int fs_exists(const char *filename); * * @filename: Name of the file * @size: Size of file - * @return 0 if ok with valid *size, negative on error + * Return: 0 if ok with valid *size, negative on error */ int fs_size(const char *filename, loff_t *size); @@ -195,7 +195,7 @@ struct fs_dir_stream { * fs_opendir - Open a directory * * @filename: the path to directory to open - * @return a pointer to the directory stream or NULL on error and errno + * Return: a pointer to the directory stream or NULL on error and errno * set appropriately */ struct fs_dir_stream *fs_opendir(const char *filename); @@ -209,7 +209,7 @@ struct fs_dir_stream *fs_opendir(const char *filename); * longer valid. * * @dirs: the directory stream - * @return the next directory entry (only valid until next fs_readdir() or + * Return: the next directory entry (only valid until next fs_readdir() or * fs_closedir() call, do not attempt to free()) or NULL if the end of * the directory is reached. */ @@ -228,7 +228,7 @@ void fs_closedir(struct fs_dir_stream *dirs); * If a given name is a directory, it will be deleted only if it's empty * * @filename: Name of file or directory to delete - * @return 0 on success, -1 on error conditions + * Return: 0 on success, -1 on error conditions */ int fs_unlink(const char *filename); @@ -236,7 +236,7 @@ int fs_unlink(const char *filename); * fs_mkdir - Create a directory * * @filename: Name of directory to create - * @return 0 on success, -1 on error conditions + * Return: 0 on success, -1 on error conditions */ int fs_mkdir(const char *filename); @@ -281,7 +281,7 @@ int do_fs_type(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); * @flag: Command flags (CMD_FLAG_...) * @argc: Number of arguments * @argv: List of arguments - * @return result (see enum command_ret_t) + * Return: result (see enum command_ret_t) */ int do_fs_types(struct cmd_tbl *cmdtp, int flag, int argc, char * const argv[]); |