[PATCH] iio: Correct kernel-doc inconsistency

[PATCH] iio: Correct kernel-doc inconsistency

[Colton Lewis]

Silence documentation build warning by correcting kernel-doc comment
for iio_dev struct.

./include/linux/iio/iio.h:574: warning: Function parameter or member 'read_buf' not described in 'iio_dev'
./include/linux/iio/iio.h:574: warning: Function parameter or member 'read_buf_len' not described in 'iio_dev'

Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
---
 include/linux/iio/iio.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
index a1be82e74c93..48049b344e6c 100644
--- a/include/linux/iio/iio.h
+++ b/include/linux/iio/iio.h
@@ -522,6 +522,8 @@ struct iio_buffer_setup_ops {
  * @flags:		[INTERN] file ops related flags including busy flag.
  * @debugfs_dentry:	[INTERN] device specific debugfs dentry.
  * @cached_reg_addr:	[INTERN] cached register address for debugfs reads.
+ * @read_buf:		[INTERN] cached register contents for debugfs reads
+ * @read_buf_len:	[INTERN] length of @read_buf
  */
 struct iio_dev {
 	int				id;
-- 
2.26.2

Re: [PATCH] iio: Correct kernel-doc inconsistency

[Jonathan Cameron]

On Wed, 15 Jul 2020 19:17:09 +0000
Colton Lewis <colton.w.lewis@protonmail.com> wrote:

> Silence documentation build warning by correcting kernel-doc comment
> for iio_dev struct.
> 
> ./include/linux/iio/iio.h:574: warning: Function parameter or member 'read_buf' not described in 'iio_dev'
> ./include/linux/iio/iio.h:574: warning: Function parameter or member 'read_buf_len' not described in 'iio_dev'
> 
> Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
Hi Colton,

Thanks for the patch, but these elements have moved and now have docs
(very recent!)  See the testing branch of iio.git on git.kernel.org


Jonathan

> ---
>  include/linux/iio/iio.h | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
> index a1be82e74c93..48049b344e6c 100644
> --- a/include/linux/iio/iio.h
> +++ b/include/linux/iio/iio.h
> @@ -522,6 +522,8 @@ struct iio_buffer_setup_ops {
>   * @flags:		[INTERN] file ops related flags including busy flag.
>   * @debugfs_dentry:	[INTERN] device specific debugfs dentry.
>   * @cached_reg_addr:	[INTERN] cached register address for debugfs reads.
> + * @read_buf:		[INTERN] cached register contents for debugfs reads
> + * @read_buf_len:	[INTERN] length of @read_buf
>   */
>  struct iio_dev {
>  	int				id;