diff mbox series

[3/3] iio:core: Tidy up kernel-doc.

Message ID 20200913132115.800131-4-jic23@kernel.org
State New
Headers show
Series IIO get to warning free for W=1 C=1 | expand

Commit Message

Jonathan Cameron Sept. 13, 2020, 1:21 p.m. UTC
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(-)

Comments

Alexandru Ardelean Sept. 18, 2020, 12:48 p.m. UTC | #1
On Sun, Sep 13, 2020 at 4:24 PM Jonathan Cameron <jic23@kernel.org> wrote:
>
> 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.
>

Apologies for missing this earlier.

Acked-by: Alexandru Ardelean <alexandru.ardelean@analog.com>

> 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
>
Jonathan Cameron Sept. 19, 2020, 11:51 a.m. UTC | #2
On Fri, 18 Sep 2020 15:48:02 +0300
Alexandru Ardelean <ardeleanalex@gmail.com> wrote:

> On Sun, Sep 13, 2020 at 4:24 PM Jonathan Cameron <jic23@kernel.org> wrote:
> >
> > 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.
> >  
> 
> Apologies for missing this earlier.
No problem.  This one is you being nice rather than an ADI driver :)
> 
> Acked-by: Alexandru Ardelean <alexandru.ardelean@analog.com>

Thanks.  Applied with yours and Andy's tag (from the request
for review email).

Jonathan

> 
> > 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
> >
diff mbox series

Patch

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)