[PATCH] drm: document drm_mode_get_connector

Simon Ser contact at emersion.fr
Wed Nov 18 15:09:26 UTC 2020


On Wednesday, November 18, 2020 4:03 PM, Daniel Vetter <daniel at ffwll.ch> wrote:

> I think this causes warnings, because now we have kerneldoc for this,
> but not for all the members. Also the member-specific stuff should be
> documented as inline comment, see
>
> https://dri.freedesktop.org/docs/drm/doc-guide/kernel-doc.html#in-line-member-documentation-comments

Hm, right, will make sure the patch doesn't trigger warnings.

I still think the force-probe stuff shouldn't be documented in in-line
comments, because I'd never look at the in-line count_modes comment to know
whether the ioctl probes or not. Adding short in-line comments sounds fine
though.

> I also noticed that this file has a ton of wrong kerneldoc comments,
> but they seem to not cause warnings (anything starting with /** is
> fishy).
>
> Can I volunteer you for a bit more here?

Yeah, I've noticed this as well. Will have a look!


More information about the dri-devel mailing list