Thread (78 messages) 78 messages, 7 authors, 2020-12-05

Re: [PATCH v2 01/28] video: Fix kernel-doc warnings in of_display_timing + of_videomode

From: Thomas Zimmermann <tzimmermann@suse.de>
Date: 2020-11-29 10:01:21
Also in: dri-devel


Am 28.11.20 um 23:40 schrieb Sam Ravnborg:
quoted hunk ↗ jump to hunk
Fix kernel-doc warnings reported when using W=1.

v2:
   - Improve subject (Lee)

Signed-off-by: Sam Ravnborg <redacted>
Cc: Lee Jones <redacted>
Cc: linux-fbdev@vger.kernel.org
---
  drivers/video/of_display_timing.c | 1 +
  drivers/video/of_videomode.c      | 8 ++++----
  2 files changed, 5 insertions(+), 4 deletions(-)
diff --git a/drivers/video/of_display_timing.c b/drivers/video/of_display_timing.c
index abc9ada798ee..f93b6abbe258 100644
--- a/drivers/video/of_display_timing.c
+++ b/drivers/video/of_display_timing.c
@@ -52,6 +52,7 @@ static int parse_timing_property(const struct device_node *np, const char *name,
  /**
   * of_parse_display_timing - parse display_timing entry from device_node
   * @np: device_node with the properties
+ * @dt: display_timing that contains the result. I may be partially written in case of errors
   **/
  static int of_parse_display_timing(const struct device_node *np,
  		struct display_timing *dt)
diff --git a/drivers/video/of_videomode.c b/drivers/video/of_videomode.c
index 67aff2421c29..a5bb02f02b44 100644
--- a/drivers/video/of_videomode.c
+++ b/drivers/video/of_videomode.c
@@ -13,10 +13,10 @@
  #include <video/videomode.h>
  
  /**
- * of_get_videomode - get the videomode #<index> from devicetree
What's wrong with this line? We use the dash in lots of places?

Besides this,

Acked-by: Thomas Zimmermann <tzimmermann@suse.de>
- * @np - devicenode with the display_timings
- * @vm - set to return value
- * @index - index into list of display_timings
+ * of_get_videomode: get the videomode #<index> from devicetree
+ * @np: devicenode with the display_timings
+ * @vm: set to return value
+ * @index: index into list of display_timings
   *	    (Set this to OF_USE_NATIVE_MODE to use whatever mode is
   *	     specified as native mode in the DT.)
   *
-- 
Thomas Zimmermann
Graphics Driver Developer
SUSE Software Solutions Germany GmbH
Maxfeldstr. 5, 90409 Nürnberg, Germany
(HRB 36809, AG Nürnberg)
Geschäftsführer: Felix Imendörffer

Attachments

Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help