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>

diff --git a/include/linux/iio/buffer_impl.h b/include/linux/iio/buffer_impl.h
index c0b0e0992a85b2813a126c1a61f13f1ed0b498dd..9442c165561a0396d7155c971d0c0301616cf085 100644 (file)
--- a/include/linux/iio/buffer_impl.h
+++ b/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,