[PATCH 1/2] string: fix kerneldoc formatting in strends()

Bartosz Golaszewski posted 2 patches 1 week, 6 days ago
[PATCH 1/2] string: fix kerneldoc formatting in strends()
Posted by Bartosz Golaszewski 1 week, 6 days ago
From: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>

strends() kernel doc should have used `@str:` format for arguments
instead of `@str -`.

Fixes: 197b3f3c70d6 ("string: provide strends()")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/all/20251118134748.40f03b9c@canb.auug.org.au/
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
---
 include/linux/string.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/string.h b/include/linux/string.h
index 929d05d1247c76eb9011fe34250b487834b2d3c9..69e9256592f87e446d6f0be5034056aa7d0b78b0 100644
--- a/include/linux/string.h
+++ b/include/linux/string.h
@@ -564,8 +564,8 @@ static inline bool strstarts(const char *str, const char *prefix)
 
 /**
  * strends - Check if a string ends with another string.
- * @str - NULL-terminated string to check against @suffix
- * @suffix - NULL-terminated string defining the suffix to look for in @str
+ * @str: NULL-terminated string to check against @suffix
+ * @suffix: NULL-terminated string defining the suffix to look for in @str
  *
  * Returns:
  * True if @str ends with @suffix. False in all other cases.

-- 
2.51.0