On Thursday, November 19, 2020 4:06 PM, Daniel Vetter <daniel@xxxxxxxx> wrote: > > + /** > > + * @connection: Status of the connector. > > + * > > + * See enum drm_connector_status. > > Please add & so it becomes a link in the generated docs (and pls check > the link goes to the right place). Per [1], just prefixing the enum name with "enum" is enough to generate a link. I prefer this style over the ampersand because it makes the raw text easier to read. The result looks like this [2]. [1]: https://dri.freedesktop.org/docs/drm/doc-guide/kernel-doc.html#cross-referencing-from-restructuredtext [2]: https://l.sr.ht/o7Kb.png > > + */ > > __u32 connection; > > - __u32 mm_width; /**< width in millimeters */ > > - __u32 mm_height; /**< height in millimeters */ > > + /** @mm_width: Width of the connected sink in millimeters. */ > > + __u32 mm_width; > > + /** @mm_height: Height of the connected sink in millimeters. */ > > + __u32 mm_height; > > + /** > > + * @subpixel: Subpixel order of the connected sink. > > + * > > + * See enum subpixel_order. > > Same here. This one doesn't generate a link, because enum subpixel_order is undocumented. As soon as it's documented, the link will be created. The enum is weird in the first place: it has CamelCase members and no drm_ prefix. > With the nits addressed: Reviewed-by: Daniel Vetter <daniel.vetter@xxxxxxxx> I'll fix the other issues you've raised, thanks for the review! _______________________________________________ dri-devel mailing list dri-devel@xxxxxxxxxxxxxxxxxxxxx https://lists.freedesktop.org/mailman/listinfo/dri-devel
