drm/writeback: wire drm_writeback.h to kernel-doc

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@ravnborg.org>
Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Cc: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>
Cc: Brian Starkey <brian.starkey@arm.com>
Cc: Liviu Dudau <liviu.dudau@arm.com>
Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
Cc: Thomas Zimmermann <tzimmermann@suse.de>
Cc: Maxime Ripard <mripard@kernel.org>
Link: https://patchwork.freedesktop.org/patch/msgid/20200406194746.26433-4-sam@ravnborg.org
This commit is contained in:
Sam Ravnborg 2020-04-06 21:47:46 +02:00
parent 21de71f6db
commit e2d7fc20b3
2 changed files with 12 additions and 0 deletions

View File

@ -397,6 +397,9 @@ Connector Functions Reference
Writeback Connectors Writeback Connectors
-------------------- --------------------
.. kernel-doc:: include/drm/drm_writeback.h
:internal:
.. kernel-doc:: drivers/gpu/drm/drm_writeback.c .. kernel-doc:: drivers/gpu/drm/drm_writeback.c
:doc: overview :doc: overview

View File

@ -15,7 +15,13 @@
#include <drm/drm_encoder.h> #include <drm/drm_encoder.h>
#include <linux/workqueue.h> #include <linux/workqueue.h>
/**
* struct drm_writeback_connector - DRM writeback connector
*/
struct drm_writeback_connector { struct drm_writeback_connector {
/**
* @base: base drm_connector object
*/
struct drm_connector base; struct drm_connector base;
/** /**
@ -78,6 +84,9 @@ struct drm_writeback_connector {
char timeline_name[32]; char timeline_name[32];
}; };
/**
* struct drm_writeback_job - DRM writeback job
*/
struct drm_writeback_job { struct drm_writeback_job {
/** /**
* @connector: * @connector: