linux-iio.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Cameron <jic23@kernel.org>
To: Luis de Bethencourt <luisbg@osg.samsung.com>,
	linux-kernel@vger.kernel.org
Cc: knaack.h@gmx.de, lars@metafoo.de, pmeerw@pmeerw.net,
	linux-iio@vger.kernel.org
Subject: Re: [PATCH] iio: buffer: add missing descriptions in iio_buffer_access_funcs
Date: Mon, 28 Mar 2016 15:32:27 +0100	[thread overview]
Message-ID: <56F9407B.3010308@kernel.org> (raw)
In-Reply-To: <1458736481-8928-1-git-send-email-luisbg@osg.samsung.com>

On 23/03/16 12:34, Luis de Bethencourt wrote:
> The members buffer_group and attrs of iio_buffer_access_funcs have no
> descriptions for the documentation. Adding them.
> 
> Fixes: 08e7e0adaa17 ("iio: buffer: Allocate standard attributes in the core")
> Signed-off-by: Luis de Bethencourt <luisbg@osg.samsung.com>
Applied - thanks for clearing that up.

Jonathan
> ---
> Hi,
> 
> I noticed these warnings when running make htmldocs:
> .//include/linux/iio/buffer.h:114: warning: No description found for parameter 'buffer_group'
> .//include/linux/iio/buffer.h:114: warning: No description found for parameter 'attrs'
> 
> 
> Thanks,
> Luis
> 
>  include/linux/iio/buffer.h | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/include/linux/iio/buffer.h b/include/linux/iio/buffer.h
> index 2ec3ad5..70a5164 100644
> --- a/include/linux/iio/buffer.h
> +++ b/include/linux/iio/buffer.h
> @@ -83,10 +83,12 @@ struct iio_buffer_access_funcs {
>   * @access:		[DRIVER] buffer access functions associated with the
>   *			implementation.
>   * @scan_el_dev_attr_list:[INTERN] list of scan element related attributes.
> + * @buffer_group:	[INTERN] attributes of the buffer group
>   * @scan_el_group:	[DRIVER] attribute group for those attributes not
>   *			created from the iio_chan_info array.
>   * @pollq:		[INTERN] wait queue to allow for polling on the buffer.
>   * @stufftoread:	[INTERN] flag to indicate new data.
> + * @attrs:		[INTERN] standard attributes of the buffer
>   * @demux_list:		[INTERN] list of operations required to demux the scan.
>   * @demux_bounce:	[INTERN] buffer for doing gather from incoming scan.
>   * @buffer_list:	[INTERN] entry in the devices list of current buffers.
> 


      reply	other threads:[~2016-03-28 14:32 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-03-23 12:34 [PATCH] iio: buffer: add missing descriptions in iio_buffer_access_funcs Luis de Bethencourt
2016-03-28 14:32 ` Jonathan Cameron [this message]

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=56F9407B.3010308@kernel.org \
    --to=jic23@kernel.org \
    --cc=knaack.h@gmx.de \
    --cc=lars@metafoo.de \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=luisbg@osg.samsung.com \
    --cc=pmeerw@pmeerw.net \
    /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;
as well as URLs for NNTP newsgroup(s).