Commit 4d9784c0 authored by Yang Li's avatar Yang Li Committed by Andrew Morton
Browse files

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: default avatarYang Li <yang.lee@linux.alibaba.com>
Acked-by: default avatarOGAWA Hirofumi <hirofumi@mail.parknet.co.jp>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent 61b258b0

fs/fat/dir.c

+12 −0
Original line number Diff line number Diff line
@@ -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:

 *