public inbox for linux-iio@vger.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Cameron <jic23@kernel.org>
To: linux-iio@vger.kernel.org
Cc: Lee Jones <lee.jones@linaro.org>,
	Jonathan Cameron <Jonathan.Cameron@huawei.com>
Subject: [PATCH 3/3] iio:core: Tidy up kernel-doc.
Date: Sun, 13 Sep 2020 14:21:15 +0100	[thread overview]
Message-ID: <20200913132115.800131-4-jic23@kernel.org> (raw)
In-Reply-To: <20200913132115.800131-1-jic23@kernel.org>

From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

One comment isn't kernel-doc at all, but starts with /** and another
is simply missing a parameter that was introduced recently.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
---
 drivers/iio/industrialio-core.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/iio/industrialio-core.c b/drivers/iio/industrialio-core.c
index 8ddc6dfc8ed4..6e388293c828 100644
--- a/drivers/iio/industrialio-core.c
+++ b/drivers/iio/industrialio-core.c
@@ -170,7 +170,7 @@ static const char * const iio_chan_info_postfix[] = {
 };
 
 #if defined(CONFIG_DEBUG_FS)
-/**
+/*
  * There's also a CONFIG_DEBUG_FS guard in include/linux/iio/iio.h for
  * iio_get_debugfs_dentry() to make it inline if CONFIG_DEBUG_FS is undefined
  */
@@ -1525,6 +1525,7 @@ struct device_type iio_device_type = {
 
 /**
  * iio_device_alloc() - allocate an iio_dev from a driver
+ * @parent:		Parent device.
  * @sizeof_priv:	Space to allocate for private structure.
  **/
 struct iio_dev *iio_device_alloc(struct device *parent, int sizeof_priv)
-- 
2.28.0


  parent reply	other threads:[~2020-09-13 13:23 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-13 13:21 [PATCH 0/3] IIO get to warning free for W=1 C=1 Jonathan Cameron
2020-09-13 13:21 ` [PATCH 1/3] iio:imu:adis16400: Sort out missing kernel doc Jonathan Cameron
2020-09-14  5:52   ` Alexandru Ardelean
2020-09-17 18:02     ` Jonathan Cameron
2020-09-13 13:21 ` [PATCH 2/3] iio: Add __printf() attributes to various allocation functions Jonathan Cameron
2020-09-18 13:25   ` Alexandru Ardelean
2020-09-19 12:08     ` Jonathan Cameron
2020-09-13 13:21 ` Jonathan Cameron [this message]
2020-09-18 12:48   ` [PATCH 3/3] iio:core: Tidy up kernel-doc Alexandru Ardelean
2020-09-19 11:51     ` Jonathan Cameron

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=20200913132115.800131-4-jic23@kernel.org \
    --to=jic23@kernel.org \
    --cc=Jonathan.Cameron@huawei.com \
    --cc=lee.jones@linaro.org \
    --cc=linux-iio@vger.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