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

From: Randy Dunlap

Date: Wed Jan 28 2026 - 15:07:28 EST


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) and remove one stray space
in a kernel-doc comment.

Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
---
v2: remove a stray space in a kernel-doc comment (Andy)

Cc: Jonathan Cameron <jic23@xxxxxxxxxx>
Cc: David Lechner <dlechner@xxxxxxxxxxxx>
Cc: Nuno Sá <nuno.sa@xxxxxxxxxx>
Cc: Andy Shevchenko <andy@xxxxxxxxxx>
Cc: linux-iio@xxxxxxxxxxxxxxx

include/linux/iio/buffer_impl.h | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)

--- linux-next-20260128.orig/include/linux/iio/buffer_impl.h
+++ linux-next-20260128/include/linux/iio/buffer_impl.h
@@ -113,10 +113,10 @@ struct iio_buffer {
/** @flags: File ops flags including busy flag. */
unsigned long flags;

- /** @bytes_per_datum: Size of individual datum including timestamp. */
+ /** @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,