Re: [PATCH v3] staging: media: atomisp: Fix typos and formatting in headers
From: Andy Shevchenko
Date: Thu Jan 15 2026 - 11:41:14 EST
On Thu, Jan 15, 2026 at 6:32 PM Hamdan Khan <hamdankhan212@xxxxxxxxx> wrote:
>
> > Have you tried to run kernel-doc script against this file? I believe
> > it will be a difference between before and after.
>
> I just ran the kernel-doc script for both the previous and updated
> comments. The script doesn't detect kernel-doc for either of them,
> comments even with /** because they're missing the struct
> definition in the comment like:
>
> /**
> * struct atomisp_dvs2_coef_types - Brief description
> * @odd_real: Real part of the odd coefficients
> * @odd_imag: Imaginary part of the odd coefficients
> * ... so on
> */
>
> Though, these can be converted to be kernel-doc compliant if you
> prefer it.
In this case it's not needed. Please, clarify in the commit message
that even if some comments look like kernel-doc, they are not.
--
With Best Regards,
Andy Shevchenko