diff options
| author | Yang Li <yang.lee@linux.alibaba.com> | 2024-03-22 15:37:24 +0800 |
|---|---|---|
| committer | Andrew Morton <akpm@linux-foundation.org> | 2024-04-25 21:07:02 -0700 |
| commit | 4d9784c00a15631b68a5d95be907aa308f269551 (patch) | |
| tree | 3996d81144d54f0b431f57fe700ab2ae485c63ef /fs/fat | |
| parent | 61b258b0d2f60858888e248da9744d63e0fa6856 (diff) | |
| download | linux-4d9784c00a15631b68a5d95be907aa308f269551.tar.gz linux-4d9784c00a15631b68a5d95be907aa308f269551.tar.bz2 linux-4d9784c00a15631b68a5d95be907aa308f269551.zip | |
fs: add kernel-doc comments to fat_parse_long()
Add kernel-doc style comments with complete parameter descriptions for
fat_parse_long().
Link: https://lkml.kernel.org/r/20240322073724.102332-1-yang.lee@linux.alibaba.com
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
Acked-by: OGAWA Hirofumi <hirofumi@mail.parknet.co.jp>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Diffstat (limited to 'fs/fat')
| -rw-r--r-- | fs/fat/dir.c | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/fs/fat/dir.c b/fs/fat/dir.c index 00235b8a1823..acbec5bdd521 100644 --- a/fs/fat/dir.c +++ b/fs/fat/dir.c @@ -269,6 +269,18 @@ enum { PARSE_INVALID = 1, PARSE_NOT_LONGNAME, PARSE_EOF, }; /** * fat_parse_long - Parse extended directory entry. * + * @dir: Pointer to the inode that represents the directory. + * @pos: On input, contains the starting position to read from. + * On output, updated with the new position. + * @bh: Pointer to the buffer head that may be used for reading directory + * entries. May be updated. + * @de: On input, points to the current directory entry. + * On output, points to the next directory entry. + * @unicode: Pointer to a buffer where the parsed Unicode long filename will be + * stored. + * @nr_slots: Pointer to a variable that will store the number of longname + * slots found. + * * This function returns zero on success, negative value on error, or one of * the following: * |