[PATCH] drm: add documentation for tv connector state margins
Daniel Vetter
daniel at ffwll.ch
Mon Feb 19 15:45:37 UTC 2018
On Mon, Feb 19, 2018 at 12:40:09PM +0200, Jani Nikula wrote:
> A bit boring documentation fix, but gets rid of the warnings:
>
> ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.left' not described in 'drm_tv_connector_state'
> ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.right' not described in 'drm_tv_connector_state'
> ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.top' not described in 'drm_tv_connector_state'
> ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.bottom' not described in 'drm_tv_connector_state'
>
> Signed-off-by: Jani Nikula <jani.nikula at intel.com>
> ---
> include/drm/drm_connector.h | 6 +++++-
> 1 file changed, 5 insertions(+), 1 deletion(-)
>
> diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
> index 758a176e7b57..675cc3f8cf85 100644
> --- a/include/drm/drm_connector.h
> +++ b/include/drm/drm_connector.h
> @@ -342,7 +342,11 @@ int drm_display_info_set_bus_formats(struct drm_display_info *info,
> /**
> * struct drm_tv_connector_state - TV connector related states
> * @subconnector: selected subconnector
> - * @margins: left/right/top/bottom margins
> + * @margins: margins
> + * @margins.left: left margin
> + * @margins.right: right margin
> + * @margins.top: top margin
> + * @margins.bottom: bottom margin
Reviewed-by: Daniel Vetter <daniel.vetter at ffwll.ch>
Well, applying this will now generate a warning on older kerneldocs (due
to lack of docs for @margins), but oh well. Can/should we keep both?
-Daniel
> * @mode: TV mode
> * @brightness: brightness in percent
> * @contrast: contrast in percent
> --
> 2.11.0
>
> _______________________________________________
> dri-devel mailing list
> dri-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
More information about the dri-devel
mailing list