From: Randy Dunlap Date: Thu, 19 Feb 2026 21:55:24 +0000 (-0800) Subject: drm/sun4i: fix kernel-doc warnings in sunxi_engine.h X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=645186bf86932c6b9deed2e564cffd09576ba9a4;p=thirdparty%2Fkernel%2Flinux.git drm/sun4i: fix kernel-doc warnings in sunxi_engine.h Correct the kernel-doc notation, add a missing struct member comment, and add a missing "Returns:" function comment to eliminate kernel-doc warnings: Warning: drivers/gpu/drm/sun4i/sunxi_engine.h:116 Incorrect use of kernel-doc format: * @mode_set Warning: drivers/gpu/drm/sun4i/sunxi_engine.h:125 struct member 'mode_set' not described in 'sunxi_engine_ops' Warning: drivers/gpu/drm/sun4i/sunxi_engine.h:144 struct member 'list' not described in 'sunxi_engine' Warning: drivers/gpu/drm/sun4i/sunxi_engine.h:168 No description found for return value of 'sunxi_engine_layers_init' Signed-off-by: Randy Dunlap Reviewed-by: Chen-Yu Tsai Link: https://patch.msgid.link/20260219215524.468142-1-rdunlap@infradead.org Signed-off-by: Chen-Yu Tsai --- diff --git a/drivers/gpu/drm/sun4i/sunxi_engine.h b/drivers/gpu/drm/sun4i/sunxi_engine.h index ec0c4932f15cf..c9461de06cd04 100644 --- a/drivers/gpu/drm/sun4i/sunxi_engine.h +++ b/drivers/gpu/drm/sun4i/sunxi_engine.h @@ -114,7 +114,7 @@ struct sunxi_engine_ops { void (*vblank_quirk)(struct sunxi_engine *engine); /** - * @mode_set + * @mode_set: * * This callback is used to set mode related parameters * like interlacing, screen size, etc. once per mode set. @@ -131,6 +131,7 @@ struct sunxi_engine_ops { * @node: the of device node of the engine * @regs: the regmap of the engine * @id: the id of the engine (-1 if not used) + * @list: engine list management */ struct sunxi_engine { const struct sunxi_engine_ops *ops; @@ -140,7 +141,6 @@ struct sunxi_engine { int id; - /* Engine list management */ struct list_head list; }; @@ -163,6 +163,9 @@ sunxi_engine_commit(struct sunxi_engine *engine, * sunxi_engine_layers_init() - Create planes (layers) for the engine * @drm: pointer to the drm_device for which planes will be created * @engine: pointer to the engine + * + * Returns: The array of struct drm_plane backing the layers, or an + * error pointer on failure. */ static inline struct drm_plane ** sunxi_engine_layers_init(struct drm_device *drm, struct sunxi_engine *engine)