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 <[email protected]>
---
Cc: Chen-Yu Tsai <[email protected]>
Cc: Maarten Lankhorst <[email protected]>
Cc: Maxime Ripard <[email protected]>
Cc: Thomas Zimmermann <[email protected]>
Cc: David Airlie <[email protected]>
Cc: Simona Vetter <[email protected]>
Cc: Jernej Skrabec <[email protected]>
Cc: Samuel Holland <[email protected]>
Cc: [email protected]
Cc: [email protected]
---
 drivers/gpu/drm/sun4i/sunxi_engine.h |    7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

--- linux-next-20251121.orig/drivers/gpu/drm/sun4i/sunxi_engine.h
+++ linux-next-20251121/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
  * 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)

Reply via email to