public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
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	[thread overview]
Message-ID: <20210421143124.17873-1-lukas.bulwahn@gmail.com> (raw)

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


             reply	other threads:[~2021-04-21 14:31 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-21 14:31 Lukas Bulwahn [this message]
2021-04-21 15:30 ` [PATCH] of: address recent kernel-doc warnings Rob Herring

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210421143124.17873-1-lukas.bulwahn@gmail.com \
    --to=lukas.bulwahn@gmail.com \
    --cc=devicetree@vger.kernel.org \
    --cc=frowand.list@gmail.com \
    --cc=kernel-janitors@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=pantelis.antoniou@konsulko.com \
    --cc=robh+dt@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox