of: linux/of.h: fix kernel-doc warnings
diff mbox series

Message ID 20210417061244.2262-1-rdunlap@infradead.org
State Accepted
Commit c968b89a1d446ec4a1ed3022ebd79d36de5ea1eb
Headers show
Series
  • of: linux/of.h: fix kernel-doc warnings
Related show

Commit Message

Randy Dunlap April 17, 2021, 6:12 a.m. UTC
Correct kernel-doc notation warnings:

../include/linux/of.h:1211: warning: Function parameter or member 'output' not described in 'of_property_read_string_index'
../include/linux/of.h:1211: warning: Excess function parameter 'out_string' description in 'of_property_read_string_index'
../include/linux/of.h:1477: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Overlay support

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Rob Herring <robh@kernel.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
---
 include/linux/of.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Rob Herring April 21, 2021, 1:05 p.m. UTC | #1
On Fri, 16 Apr 2021 23:12:44 -0700, Randy Dunlap wrote:
> Correct kernel-doc notation warnings:
> 
> ../include/linux/of.h:1211: warning: Function parameter or member 'output' not described in 'of_property_read_string_index'
> ../include/linux/of.h:1211: warning: Excess function parameter 'out_string' description in 'of_property_read_string_index'
> ../include/linux/of.h:1477: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Overlay support
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Rob Herring <robh@kernel.org>
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> ---
>  include/linux/of.h |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

Applied, thanks!

Patch
diff mbox series

--- linux-next-20210416.orig/include/linux/of.h
+++ linux-next-20210416/include/linux/of.h
@@ -1192,7 +1192,7 @@  static inline int of_property_count_stri
  * @np:		device node from which the property value is to be read.
  * @propname:	name of the property to be searched.
  * @index:	index of the string in the list of strings
- * @out_string:	pointer to null terminated return string, modified only if
+ * @output:	pointer to null terminated return string, modified only if
  *		return value is 0.
  *
  * Search for a property in a device tree node and retrieve a null
@@ -1473,7 +1473,7 @@  static inline bool of_device_is_system_p
 	return of_property_read_bool(np, "system-power-controller");
 }
 
-/**
+/*
  * Overlay support
  */