mirror of
https://source.denx.de/u-boot/u-boot.git
synced 2026-06-02 09:46:37 +03:00
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>
This commit is contained in:
16
include/fs.h
16
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[]);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user