[PATCH 17/17] linux: v4l2-vp9.h: Fix kerneldoc

Hans Verkuil hverkuil-cisco at xs4all.nl
Mon Feb 5 02:29:01 PST 2024

On 27/01/2024 10:57, Sakari Ailus wrote:
> Hi Ricardo,
> On Fri, Jan 26, 2024 at 11:16:16PM +0000, Ricardo Ribalda wrote:
>> Kerneldoc cannot understand arrays defined like
>> v4l2_frame_symbol_counts.
>> Adding an asterisk to the name does do the trick.
>> Disable the kerneldoc notation for now, it is already ignored:
>> https://docs.kernel.org/search.html?q=v4l2_vp9_frame_symbol_counts
> Wouldn't it be nicer to fix kerneldoc instead? It might not be difficult at
> all.
> Feel free to, but I can also give it a try.

It would be nice to have this fixed in kerneldoc itself. I'm holding this
patch back for two weeks to see if someone wants to work on kerneldoc.

If not, then I'll take this anyway to fix the noise in our build.

Note that while this header is indeed ignored in the documentation, that
is really more a bug and it would be nice to actually include this header
somewhere in our documentation. So fixing these kerneldoc warnings one way
or another is something that we should do.



More information about the Linux-rockchip mailing list