diff mbox series

of: address recent kernel-doc warnings

Message ID 20210421143124.17873-1-lukas.bulwahn@gmail.com
State New
Headers show
Series of: address recent kernel-doc warnings | expand

Commit Message

Lukas Bulwahn April 21, 2021, 2:31 p.m. UTC 
Recently, make htmldocs reports these kernel-doc warnings:

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

Address those kernel-doc warnings by simple adjustment of the comments.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
---
applies cleanly on next-20210421

Rob, please pick this minor clean-up patch for the devicetree tree.

 include/linux/of.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Rob Herring April 21, 2021, 3:30 p.m. UTC | #1 
On Wed, Apr 21, 2021 at 9:31 AM Lukas Bulwahn <lukas.bulwahn@gmail.com> wrote:
>
> Recently, make htmldocs reports these kernel-doc warnings:
>
>   warning: Function parameter or member 'output' not described in 'of_property_read_string_index'
>   warning: Excess function parameter 'out_string' description in 'of_property_read_string_index'
>   warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>     * Overlay support
>
> Address those kernel-doc warnings by simple adjustment of the comments.
>
> Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
> ---
> applies cleanly on next-20210421
>
> Rob, please pick this minor clean-up patch for the devicetree tree.

Already got a similar fix.
diff mbox series

Patch

diff --git a/include/linux/of.h b/include/linux/of.h
index ef6b161d1f91..4d84674f8aac 100644
--- a/include/linux/of.h
+++ b/include/linux/of.h
@@ -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
@@ -1203,7 +1203,7 @@  static inline int of_property_count_strings(const struct device_node *np,
  * property does not have a value, and -EILSEQ if the string is not
  * null-terminated within the length of the property data.
  *
- * The out_string pointer is modified only if a valid string can be decoded.
+ * The output pointer is modified only if a valid string can be decoded.
  */
 static inline int of_property_read_string_index(const struct device_node *np,
 						const char *propname,
@@ -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
  */