Skip to content

Commit bf870c9

Browse files
rddunlapjic23
authored andcommitted
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>
1 parent b79b24f commit bf870c9

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

include/linux/iio/buffer_impl.h

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,10 +113,10 @@ struct iio_buffer {
113113
/** @flags: File ops flags including busy flag. */
114114
unsigned long flags;
115115

116-
/** @bytes_per_datum: Size of individual datum including timestamp. */
116+
/** @bytes_per_datum: Size of individual datum including timestamp. */
117117
size_t bytes_per_datum;
118118

119-
/* @direction: Direction of the data stream (in/out). */
119+
/** @direction: Direction of the data stream (in/out). */
120120
enum iio_buffer_direction direction;
121121

122122
/**
@@ -178,7 +178,9 @@ struct iio_buffer {
178178
* @insert_buffer: buffer to insert
179179
* @remove_buffer: buffer_to_remove
180180
*
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
182184
*/
183185
int iio_update_buffers(struct iio_dev *indio_dev,
184186
struct iio_buffer *insert_buffer,

0 commit comments

Comments
 (0)