Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Lukas Bulwahn <lukas.bulwahn@gmail.com>
To:     Rob Herring <robh+dt@kernel.org>,
        Frank Rowand <frowand.list@gmail.com>,
        Pantelis Antoniou <pantelis.antoniou@konsulko.com>,
        devicetree@vger.kernel.org
Cc:     linux-doc@vger.kernel.org, kernel-janitors@vger.kernel.org,
        linux-kernel@vger.kernel.org,
        Lukas Bulwahn <lukas.bulwahn@gmail.com>
Subject: [PATCH] of: address recent kernel-doc warnings
Date:   Wed, 21 Apr 2021 16:31:24 +0200
Message-Id: <20210421143124.17873-1-lukas.bulwahn@gmail.com>
Precedence: bulk

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(-)

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
  */
 
-- 
2.17.1