Thread (48 messages) 48 messages, 7 authors, 2024-02-05

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

From: Randy Dunlap <hidden>
Date: 2024-02-05 10:40:09
Also in: linux-amlogic, linux-arm-msm, linux-media, linux-mediatek, linux-rockchip, linux-samsung-soc, linux-staging, lkml


On 2/5/24 02:29, Hans Verkuil wrote:
On 27/01/2024 10:57, Sakari Ailus wrote:
quoted
Hi Ricardo,

On Fri, Jan 26, 2024 at 11:16:16PM +0000, Ricardo Ribalda wrote:
quoted
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.
It's just waiting for Jon to apply it: (from Sakari)

https://lore.kernel.org/all/20240131084934.191226-1-sakari.ailus@linux.intel.com/ (local)

Thanks.

-- 
#Randy

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help