iio: Fix typos in the struct iio_event_spec documentation comments
authorWilliam Breathitt Gray <vilhelm.gray@gmail.com>
Mon, 15 Feb 2016 17:47:42 +0000 (12:47 -0500)
committerJonathan Cameron <jic23@kernel.org>
Wed, 17 Feb 2016 21:11:08 +0000 (21:11 +0000)
This patch fixes a few minor typos in the documentation comments for the
scan_type member of the iio_event_spec structure. The sign member name
was improperly capitalized as "Sign" in the comments. The storagebits
member name was improperly listed as "storage_bits" in the comments. The
endianness member entry in the comments was moved after the repeat
member entry in order to maintain consistency with the actual struct
iio_event_spec layout.

Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com>
Signed-off-by: Jonathan Cameron <jic23@kernel.org>
include/linux/iio/iio.h

index ce9e9c1adf34fa681d1c4b51d360aee89700264f..b2b16772c651001085a3e55a8b0712b32c193a0d 100644 (file)
@@ -180,18 +180,18 @@ struct iio_event_spec {
  * @address:           Driver specific identifier.
  * @scan_index:                Monotonic index to give ordering in scans when read
  *                     from a buffer.
- * @scan_type:         Sign:           's' or 'u' to specify signed or unsigned
+ * @scan_type:         sign:           's' or 'u' to specify signed or unsigned
  *                     realbits:       Number of valid bits of data
- *                     storage_bits:   Realbits + padding
+ *                     storagebits:    Realbits + padding
  *                     shift:          Shift right by this before masking out
  *                                     realbits.
- *                     endianness:     little or big endian
  *                     repeat:         Number of times real/storage bits
  *                                     repeats. When the repeat element is
  *                                     more than 1, then the type element in
  *                                     sysfs will show a repeat value.
  *                                     Otherwise, the number of repetitions is
  *                                     omitted.
+ *                     endianness:     little or big endian
  * @info_mask_separate: What information is to be exported that is specific to
  *                     this channel.
  * @info_mask_shared_by_type: What information is to be exported that is shared