fs: Add kernel-doc comments to fat_parse_long()
PATCH v2 1/1 fs: Add kernel-doc comments to fat_parse_long()
This commit adds kernel-doc style comments with complete parameter descriptions for the function fat_parse_long.
Signed-off-by Yang Li <[email protected]>
--- fs/fat/dir.c | 10 ++++++++++ 1 file changed, 10 insertions(+)
fs/fat/dir.c +12 -0
@@ -269,6 +269,16 @@ 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:
*
Signature · 1 line
2.20.1.7.g153144c
Quoted 4 lines · Yang Li
This commit adds kernel-doc style comments with complete parameter descriptions for the function
fat_parse_long.Signed-off-by Yang Li <[email protected]>
Looks good.
Acked-by OGAWA Hirofumi <[email protected]>
Quoted 27 lines
--- fs/fat/dir.c | 10 ++++++++++ 1 file changed, 10 insertions(+)fs/fat/dir.c +12
-0@@ -269,6 +269,16 @@ 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: *
Signature · 1 line
OGAWA Hirofumi <[email protected]>