Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752001AbbHBR1V (ORCPT ); Sun, 2 Aug 2015 13:27:21 -0400 Received: from saturn.retrosnub.co.uk ([178.18.118.26]:45365 "EHLO saturn.retrosnub.co.uk" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751180AbbHBR1T (ORCPT ); Sun, 2 Aug 2015 13:27:19 -0400 Subject: Re: [PATCH 2/6] iio: buffer: Fix kernel docs warnings To: Cristina Opriceana References: Cc: knaack.h@gmx.de, lars@metafoo.de, pmeerw@pmeerw.net, linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org, daniel.baluta@intel.com From: Jonathan Cameron Message-ID: <55BE52F6.7020608@kernel.org> Date: Sun, 2 Aug 2015 18:27:18 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:38.0) Gecko/20100101 Thunderbird/38.1.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=windows-1252 Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 2475 Lines: 61 On 24/07/15 14:18, Cristina Opriceana wrote: > Fix kernel docs for structures and functions in order to > remove some warnings when the documentation gets generated. > > Signed-off-by: Cristina Opriceana Applied with another typo fixed up. > --- > drivers/iio/industrialio-buffer.c | 15 ++++++++++++++- > 1 file changed, 14 insertions(+), 1 deletion(-) > > diff --git a/drivers/iio/industrialio-buffer.c b/drivers/iio/industrialio-buffer.c > index b13f941..a671953 100644 > --- a/drivers/iio/industrialio-buffer.c > +++ b/drivers/iio/industrialio-buffer.c > @@ -91,9 +91,16 @@ static bool iio_buffer_ready(struct iio_dev *indio_dev, struct iio_buffer *buf, > > /** > * iio_buffer_read_first_n_outer() - chrdev read for buffer access > + * @filp: File structure pointer for the char device > + * @buf: Destination buffer for iio buffer read > + * @n: First n bytes to read > + * @f_ps: Long offset provided by the user as a seek position > * > * This function relies on all buffer implementations having an > * iio_buffer as their first element. > + * > + * Return: negative values corresponding to error codes or ret != 0 > + * for ending the reading activity > **/ > ssize_t iio_buffer_read_first_n_outer(struct file *filp, char __user *buf, > size_t n, loff_t *f_ps) > @@ -143,6 +150,12 @@ ssize_t iio_buffer_read_first_n_outer(struct file *filp, char __user *buf, > > /** > * iio_buffer_poll() - poll the buffer to find out if it has data > + * @filp: File structure poiner for device access pointer > + * @wait: Poll table structure pointer for which the driver adds > + * a wait queue > + * > + * Return: (POLLIN | POLLRDNORM) if data is available for reading > + * or 0 for other cases > */ > unsigned int iio_buffer_poll(struct file *filp, > struct poll_table_struct *wait) > @@ -1136,7 +1149,7 @@ int iio_scan_mask_query(struct iio_dev *indio_dev, > EXPORT_SYMBOL_GPL(iio_scan_mask_query); > > /** > - * struct iio_demux_table() - table describing demux memcpy ops > + * struct iio_demux_table - table describing demux memcpy ops > * @from: index to copy from > * @to: index to copy to > * @length: how many bytes to copy > -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/