[PATCH v2] siphash: clean up kernel-doc comments

[PATCH v2] siphash: clean up kernel-doc comments

[Randy Dunlap]

Use the correct function parameter names and add function return
value descriptions to avoid kernel-doc warnings:

Warning: include/linux/siphash.h:82 function parameter 'len' not described
 in 'siphash'
Warning: include/linux/siphash.h:82 No description found for return value
 of 'siphash'
Warning: include/linux/siphash.h:132 function parameter 'len' not
 described in 'hsiphash'
Warning: include/linux/siphash.h:132 No description found for return value
 of 'hsiphash'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
v2: rebase & resend

Cc: Jason A. Donenfeld <Jason@zx2c4.com>

 include/linux/siphash.h |    8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

--- linux-next-20260828.orig/include/linux/siphash.h
+++ linux-next-20260828/include/linux/siphash.h
@@ -75,8 +75,10 @@ static inline u64 ___siphash_aligned(con
 /**
  * siphash - compute 64-bit siphash PRF value
  * @data: buffer to hash
- * @size: size of @data
+ * @len: size of @data
  * @key: the siphash key
+ *
+ * Returns: siphash PRF value
  */
 static inline u64 siphash(const void *data, size_t len,
 			  const siphash_key_t *key)
@@ -125,8 +127,10 @@ static inline u32 ___hsiphash_aligned(co
 /**
  * hsiphash - compute 32-bit hsiphash PRF value
  * @data: buffer to hash
- * @size: size of @data
+ * @len: size of @data
  * @key: the hsiphash key
+ *
+ * Returns: hsiphash PRF value
  */
 static inline u32 hsiphash(const void *data, size_t len,
 			   const hsiphash_key_t *key)

Re: [PATCH v2] siphash: clean up kernel-doc comments

[Jason A. Donenfeld]

On Sun, Aug 30, 2026 at 10:52:36PM -0700, Randy Dunlap wrote:
> Use the correct function parameter names and add function return
> value descriptions to avoid kernel-doc warnings:
> 
> Warning: include/linux/siphash.h:82 function parameter 'len' not described
>  in 'siphash'
> Warning: include/linux/siphash.h:82 No description found for return value
>  of 'siphash'
> Warning: include/linux/siphash.h:132 function parameter 'len' not
>  described in 'hsiphash'
> Warning: include/linux/siphash.h:132 No description found for return value
>  of 'hsiphash'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Applied. Thank you.