Re: [PATCH v15 00/29] drm/connector: Create HDMI Connector infrastructure

[Jani Nikula]

On Mon, 27 May 2024, Maxime Ripard <mripard@xxxxxxxxxx> wrote:
> Let me know what you think,

Sorry to report that this series generates a bunch of kernel-doc
warnings in include/drm/drm_connector.h. Documenting nested struct
members doesn't work as smoothly as you'd expect:

./include/drm/drm_connector.h:1138: warning: Excess struct member 'broadcast_rgb' description in 'drm_connector_state'
./include/drm/drm_connector.h:1138: warning: Excess struct member 'infoframes' description in 'drm_connector_state'
./include/drm/drm_connector.h:1138: warning: Excess struct member 'avi' description in 'drm_connector_state'
./include/drm/drm_connector.h:1138: warning: Excess struct member 'hdr_drm' description in 'drm_connector_state'
./include/drm/drm_connector.h:1138: warning: Excess struct member 'spd' description in 'drm_connector_state'
./include/drm/drm_connector.h:1138: warning: Excess struct member 'vendor' description in 'drm_connector_state'
./include/drm/drm_connector.h:1138: warning: Excess struct member 'is_limited_range' description in 'drm_connector_state'
./include/drm/drm_connector.h:1138: warning: Excess struct member 'output_bpc' description in 'drm_connector_state'
./include/drm/drm_connector.h:1138: warning: Excess struct member 'output_format' description in 'drm_connector_state'
./include/drm/drm_connector.h:1138: warning: Excess struct member 'tmds_char_rate' description in 'drm_connector_state'
./include/drm/drm_connector.h:2112: warning: Excess struct member 'vendor' description in 'drm_connector'
./include/drm/drm_connector.h:2112: warning: Excess struct member 'product' description in 'drm_connector'
./include/drm/drm_connector.h:2112: warning: Excess struct member 'supported_formats' description in 'drm_connector'
./include/drm/drm_connector.h:2112: warning: Excess struct member 'infoframes' description in 'drm_connector'
./include/drm/drm_connector.h:2112: warning: Excess struct member 'lock' description in 'drm_connector'
./include/drm/drm_connector.h:2112: warning: Excess struct member 'audio' description in 'drm_connector'

Noticed this when I was rebasing [1]. Having that merged would find
issues in headers at build time instead of 'make htmldocs'.

In the mean time, this is the quick reproducer:

$ scripts/kernel-doc -none include/drm/drm_connector.h


BR,
Jani.

[1] https://lore.kernel.org/r/20240402140136.1722533-1-jani.nikula@xxxxxxxxx


-- 
Jani Nikula, Intel