[PATCH] iio: buffer: buffer_impl.h: fix kernel-doc warnings

[PATCH] iio: buffer: buffer_impl.h: fix kernel-doc warnings

[Randy Dunlap]

Resolve all kernel-doc warnings in buffer_impl.h:

Warning: include/linux/iio/buffer_impl.h:172 struct member 'direction' not described in 'iio_buffer'
Warning: include/linux/iio/buffer_impl.h:184 No description found for return value of 'iio_update_buffers'

Also correct one typo (word order switch).

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Jonathan Cameron <jic23@kernel.org>
Cc: David Lechner <dlechner@baylibre.com>
Cc: Nuno Sá <nuno.sa@analog.com>
Cc: Andy Shevchenko <andy@kernel.org>
Cc: linux-iio@vger.kernel.org

 include/linux/iio/buffer_impl.h |    6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

--- linux-next-20260126.orig/include/linux/iio/buffer_impl.h
+++ linux-next-20260126/include/linux/iio/buffer_impl.h
@@ -116,7 +116,7 @@ struct iio_buffer {
 	/**  @bytes_per_datum: Size of individual datum including timestamp. */
 	size_t bytes_per_datum;
 
-	/* @direction: Direction of the data stream (in/out). */
+	/** @direction: Direction of the data stream (in/out). */
 	enum iio_buffer_direction direction;
 
 	/**
@@ -178,7 +178,9 @@ struct iio_buffer {
  * @insert_buffer:	buffer to insert
  * @remove_buffer:	buffer_to_remove
  *
- * Note this will tear down the all buffering and build it up again
+ * Note this will tear down all the buffering and build it up again
+ *
+ * Returns: 0 on success or -errno on error
  */
 int iio_update_buffers(struct iio_dev *indio_dev,
 		       struct iio_buffer *insert_buffer,

Re: [PATCH] iio: buffer: buffer_impl.h: fix kernel-doc warnings

[Andy Shevchenko]

On Tue, Jan 27, 2026 at 10:25:49PM -0800, Randy Dunlap wrote:
> Resolve all kernel-doc warnings in buffer_impl.h:
> 
> Warning: include/linux/iio/buffer_impl.h:172 struct member 'direction' not described in 'iio_buffer'
> Warning: include/linux/iio/buffer_impl.h:184 No description found for return value of 'iio_update_buffers'
> 
> Also correct one typo (word order switch).

...

>  	/**  @bytes_per_datum: Size of individual datum including timestamp. */

Shouldn't we also delete here...

> -	/* @direction: Direction of the data stream (in/out). */
> +	/** @direction: Direction of the data stream (in/out). */

...or add here an extra space after asterisk?


-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH] iio: buffer: buffer_impl.h: fix kernel-doc warnings

[Randy Dunlap]

Hi,

On 1/28/26 1:44 AM, Andy Shevchenko wrote:
> On Tue, Jan 27, 2026 at 10:25:49PM -0800, Randy Dunlap wrote:
>> Resolve all kernel-doc warnings in buffer_impl.h:
>>
>> Warning: include/linux/iio/buffer_impl.h:172 struct member 'direction' not described in 'iio_buffer'
>> Warning: include/linux/iio/buffer_impl.h:184 No description found for return value of 'iio_update_buffers'
>>
>> Also correct one typo (word order switch).
> 
> ...
> 
>>  	/**  @bytes_per_datum: Size of individual datum including timestamp. */
> 
> Shouldn't we also delete here...

Yes, that's the oddball in this file.
I could adjust that...

> 
>> -	/* @direction: Direction of the data stream (in/out). */
>> +	/** @direction: Direction of the data stream (in/out). */
> 
> ...or add here an extra space after asterisk?

Negative.

-- 
~Randy