of: linux/of.h: fix kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Sat, 17 Apr 2021 06:12:44 +0000 (23:12 -0700)
committerRob Herring <robh@kernel.org>
Wed, 21 Apr 2021 15:24:41 +0000 (10:24 -0500)
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: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Rob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20210417061244.2262-1-rdunlap@infradead.org
include/linux/of.h

index ef6b161..d8db8d3 100644 (file)
@@ -1192,7 +1192,7 @@ static inline int of_property_count_strings(const struct device_node *np,
  * @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_power_controller(const struct device_node
        return of_property_read_bool(np, "system-power-controller");
 }
 
-/**
+/*
  * Overlay support
  */