iio: buffer: buffer_impl.h: fix kernel-doc warnings
PATCH 1/1 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).
---
Cc: Jonathan Cameron <[email protected]>
Cc: David Lechner <[email protected]>
Cc: Nuno Sá <[email protected]>
Cc: Andy Shevchenko <[email protected]>
Cc: [email protected]
include/linux/iio/buffer_impl.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
include/linux/iio/buffer_impl.h +4 -2
@@ -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,
Quoted 6 lines · Randy Dunlap
Resolve all kernel-doc warnings in
buffer_impl.h:Warning:
include/linux/iio/buffer_impl.h:172struct member 'direction' not described in 'iio_buffer'
Warning:include/linux/iio/buffer_impl.h:184No description found for return value of 'iio_update_buffers'Also correct one typo (word order switch).
...
Quoted 1 line
/** @bytes_per_datum: Size of individual datum including timestamp. */
Shouldn't we also delete here...
include/linux/iio/buffer_impl.h struct iio_buffer { · line 119
Quoted 2 lines
include/linux/iio/buffer_impl.h +1
-1-/* @direction: Direction of the data stream (in/out). */ +/** @direction: Direction of the data stream (in/out). */
...or add here an extra space after asterisk?
Signature · 2 lines
With Best Regards, Andy Shevchenko
Hi,
Quoted 6 lines · Andy Shevchenko
Quoted 5 lines · Randy Dunlap
Resolve all kernel-doc warnings in
buffer_impl.h:Warning:
include/linux/iio/buffer_impl.h:172struct member 'direction' not described in 'iio_buffer'
Warning:include/linux/iio/buffer_impl.h:184No description found for return value of 'iio_update_buffers'
Quoted 7 lines
Quoted 1 line
Also correct one typo (word order switch).
...
Quoted 1 line
/** @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...
Quoted 5 lines
include/linux/iio/buffer_impl.h struct iio_buffer { · line 119
Quoted 3 lines
include/linux/iio/buffer_impl.h +1
-1-/* @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.
Signature · 1 line
~Randy