[PATCH -next v2] fs: Add kernel-doc comments to fat_parse_long()

[PATCH -next v2] fs: Add kernel-doc comments to fat_parse_long()

[Yang Li]

This commit adds kernel-doc style comments with complete parameter
descriptions for the function fat_parse_long.

Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 fs/fat/dir.c | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/fs/fat/dir.c b/fs/fat/dir.c
index 00235b8a1823..8236807eb7f7 100644
--- a/fs/fat/dir.c
+++ b/fs/fat/dir.c
@@ -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:
  *
-- 
2.20.1.7.g153144c

Re: [PATCH -next v2] fs: Add kernel-doc comments to fat_parse_long()

[OGAWA Hirofumi]

Yang Li <yang.lee@linux.alibaba.com> writes:

> This commit adds kernel-doc style comments with complete parameter
> descriptions for the function fat_parse_long.
>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

Looks good.

Acked-by: OGAWA Hirofumi <hirofumi@mail.parknet.co.jp>

> ---
>  fs/fat/dir.c | 10 ++++++++++
>  1 file changed, 10 insertions(+)
>
> diff --git a/fs/fat/dir.c b/fs/fat/dir.c
> index 00235b8a1823..8236807eb7f7 100644
> --- a/fs/fat/dir.c
> +++ b/fs/fat/dir.c
> @@ -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:
>   *

-- 
OGAWA Hirofumi <hirofumi@mail.parknet.co.jp>