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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <20260128200721.540666-1-rdunlap@infradead.org>
Date: Wed, 28 Jan 2026 12:07:20 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>,
	Jonathan Cameron <jic23@...nel.org>,
	David Lechner <dlechner@...libre.com>,
	Nuno Sá <nuno.sa@...log.com>,
	Andy Shevchenko <andy@...nel.org>,
	linux-iio@...r.kernel.org
Subject: [PATCH v2] iio: buffer: buffer_impl.h: fix kernel-doc warnings

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@...radead.org>
---
v2: remove a stray space in a kernel-doc comment (Andy)

Cc: Jonathan Cameron <jic23@...nel.org>
Cc: David Lechner <dlechner@...libre.com>
Cc: Nuno Sá <nuno.sa@...log.com>
Cc: Andy Shevchenko <andy@...nel.org>
Cc: linux-iio@...r.kernel.org

 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,