[PATCH v2 3/3] drm/writeback: wire drm_writeback.h to kernel-doc

[Daniel Vetter]

On Mon, Apr 06, 2020 at 09:47:46PM +0200, Sam Ravnborg wrote:
> drm_writeback.h included a lot of nice kernel-doc comments.
> Wire it up so the header file is included in the kernel-doc
> generated documentation.
> 
> Added a few simple comments to the two structs so they
> get picked up by kernel-doc.
> 
> Signed-off-by: Sam Ravnborg <sam at ravnborg.org>
> Cc: Laurent Pinchart <laurent.pinchart+renesas at ideasonboard.com>
> Cc: Brian Starkey <brian.starkey at arm.com>
> Cc: Liviu Dudau <liviu.dudau at arm.com>
> Cc: Daniel Vetter <daniel.vetter at ffwll.ch>
> Cc: Thomas Zimmermann <tzimmermann at suse.de>
> Cc: Maxime Ripard <mripard at kernel.org>
> Cc: Maxime Ripard <mripard at kernel.org>

Reviewed-by: Daniel Vetter <daniel.vetter at ffwll.ch>
> ---
>  Documentation/gpu/drm-kms.rst | 3 +++
>  include/drm/drm_writeback.h   | 9 +++++++++
>  2 files changed, 12 insertions(+)
> 
> diff --git a/Documentation/gpu/drm-kms.rst b/Documentation/gpu/drm-kms.rst
> index e1f685015807..397314d08f77 100644
> --- a/Documentation/gpu/drm-kms.rst
> +++ b/Documentation/gpu/drm-kms.rst
> @@ -397,6 +397,9 @@ Connector Functions Reference
>  Writeback Connectors
>  --------------------
>  
> +.. kernel-doc:: include/drm/drm_writeback.h
> +  :internal:
> +
>  .. kernel-doc:: drivers/gpu/drm/drm_writeback.c
>    :doc: overview
>  
> diff --git a/include/drm/drm_writeback.h b/include/drm/drm_writeback.h
> index 777c14c847f0..9697d2714d2a 100644
> --- a/include/drm/drm_writeback.h
> +++ b/include/drm/drm_writeback.h
> @@ -15,7 +15,13 @@
>  #include <drm/drm_encoder.h>
>  #include <linux/workqueue.h>
>  
> +/**
> + * struct drm_writeback_connector - DRM writeback connector
> + */
>  struct drm_writeback_connector {
> +	/**
> +	 * @base: base drm_connector object
> +	 */
>  	struct drm_connector base;
>  
>  	/**
> @@ -78,6 +84,9 @@ struct drm_writeback_connector {
>  	char timeline_name[32];
>  };
>  
> +/**
> + * struct drm_writeback_job - DRM writeback job
> + */
>  struct drm_writeback_job {
>  	/**
>  	 * @connector:
> -- 
> 2.20.1
> 

-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch