tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

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@infradead.org>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@intel.com>
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

authored by

Randy Dunlap and committed by
Jonathan Cameron bf870c97 b79b24f5

+5 -3
+5 -3
include/linux/iio/buffer_impl.h
··· 113 113 /** @flags: File ops flags including busy flag. */ 114 114 unsigned long flags; 115 115 116 - /** @bytes_per_datum: Size of individual datum including timestamp. */ 116 + /** @bytes_per_datum: Size of individual datum including timestamp. */ 117 117 size_t bytes_per_datum; 118 118 119 - /* @direction: Direction of the data stream (in/out). */ 119 + /** @direction: Direction of the data stream (in/out). */ 120 120 enum iio_buffer_direction direction; 121 121 122 122 /** ··· 178 178 * @insert_buffer: buffer to insert 179 179 * @remove_buffer: buffer_to_remove 180 180 * 181 - * Note this will tear down the all buffering and build it up again 181 + * Note this will tear down all the buffering and build it up again 182 + * 183 + * Returns: 0 on success or -errno on error 182 184 */ 183 185 int iio_update_buffers(struct iio_dev *indio_dev, 184 186 struct iio_buffer *insert_buffer,