Re: [PATCH] ath: wil6210: fix a bunch of kernel-doc warnings

[Simon Horman <horms@kernel.org>]

On Sun, Nov 16, 2025 at 06:02:13PM -0800, Randy Dunlap wrote:
> scripts/kernel-doc.py reports 51 kernel-doc warnings in wil6210.h.
> Fix all kernel-doc warnings reported in wil6210.h.
> 
> Several comments are changed from "/**" to "/*" since it appears that
> "/**" was used for many non-kernel-doc comments.
> 
> - add kernel-doc for missing function parameters
> - add one function "Returns:"
> - correct kernel-doc struct name to match actual struct name in 2 places
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

...

> @@ -444,8 +444,7 @@ static inline u8 mk_cidxtid(u8 cid, u8 t
>   * parse_cidxtid - parse @cidxtid field
>   * @cid: store CID value here
>   * @tid: store TID value here
> - *
> - * @cidxtid field encoded as bits 0..3 - CID; 4..7 - TID
> + * @cidxtid: field encoded as bits 0..3 - CID; 4..7 - TID

Hi Randy,

I wonder if it would make sense to move the @cidxtid line
so it is above the @cid line. In which case the order of
the documentation of the parameters would match their order
in the subject.

But either way, this patch looks good to me.

Reviewed-by: Simon Horman <horms@kernel.org>

>   */
>  static inline void parse_cidxtid(u8 cidxtid, u8 *cid, u8 *tid)
>  {

...