ksmbd: Add kernel-doc for ksmbd_extract_sharename() function

Yang Li · Steve French · commit a12bc36032a2 · 2024-02-07T20:23:37.000-06:00
The ksmbd_extract_sharename() function lacked a complete kernel-doc
comment. This patch adds parameter descriptions and detailed function
behavior to improve code readability and maintainability.

Signed-off-by: Yang Li &lt;yang.lee@linux.alibaba.com&gt;
Acked-by: Randy Dunlap &lt;rdunlap@infradead.org&gt;
Acked-by: Namjae Jeon &lt;linkinjeon@kernel.org&gt;
Signed-off-by: Steve French &lt;stfrench@microsoft.com&gt;
diff --git a/fs/smb/server/misc.c b/fs/smb/server/misc.c
@@ -261,6 +261,7 @@ char *ksmbd_casefold_sharename(struct unicode_map *um, const char *name)
 
 /**
  * ksmbd_extract_sharename() - get share name from tree connect request
+ * @um: pointer to a unicode_map structure for character encoding handling
  * @treename:	buffer containing tree name and share name
  *
  * Return:      share name on success, otherwise error

Original file line number	Diff line number	Diff line change
`@@ -261,6 +261,7 @@ char ksmbd_casefold_sharename(struct unicode_map um, const char *name)`
`261`	`261`
`262`	`262`	`/**`
`263`	`263`	`* ksmbd_extract_sharename() - get share name from tree connect request`
	`264`	`+ * @um: pointer to a unicode_map structure for character encoding handling`
`264`	`265`	`* @treename: buffer containing tree name and share name`
`265`	`266`	`*`
`266`	`267`	`* Return: share name on success, otherwise error`