Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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

+12
+3
Documentation/gpu/drm-kms.rst
··· 397 397 Writeback Connectors 398 398 -------------------- 399 399 400 + .. kernel-doc:: include/drm/drm_writeback.h 401 + :internal: 402 + 400 403 .. kernel-doc:: drivers/gpu/drm/drm_writeback.c 401 404 :doc: overview 402 405
+9
include/drm/drm_writeback.h
··· 15 15 #include <drm/drm_encoder.h> 16 16 #include <linux/workqueue.h> 17 17 18 + /** 19 + * struct drm_writeback_connector - DRM writeback connector 20 + */ 18 21 struct drm_writeback_connector { 22 + /** 23 + * @base: base drm_connector object 24 + */ 19 25 struct drm_connector base; 20 26 21 27 /** ··· 84 78 char timeline_name[32]; 85 79 }; 86 80 81 + /** 82 + * struct drm_writeback_job - DRM writeback job 83 + */ 87 84 struct drm_writeback_job { 88 85 /** 89 86 * @connector: