Commit 3347a065 authored by William Breathitt Gray's avatar William Breathitt Gray Committed by Jonathan Cameron

iio: Fix typos in the struct iio_event_spec documentation comments

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: default avatarWilliam Breathitt Gray <vilhelm.gray@gmail.com>
Signed-off-by: default avatarJonathan Cameron <jic23@kernel.org>
parent 3d5032a0
...@@ -180,18 +180,18 @@ struct iio_event_spec { ...@@ -180,18 +180,18 @@ struct iio_event_spec {
* @address: Driver specific identifier. * @address: Driver specific identifier.
* @scan_index: Monotonic index to give ordering in scans when read * @scan_index: Monotonic index to give ordering in scans when read
* from a buffer. * 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 * realbits: Number of valid bits of data
* storage_bits: Realbits + padding * storagebits: Realbits + padding
* shift: Shift right by this before masking out * shift: Shift right by this before masking out
* realbits. * realbits.
* endianness: little or big endian
* repeat: Number of times real/storage bits * repeat: Number of times real/storage bits
* repeats. When the repeat element is * repeats. When the repeat element is
* more than 1, then the type element in * more than 1, then the type element in
* sysfs will show a repeat value. * sysfs will show a repeat value.
* Otherwise, the number of repetitions is * Otherwise, the number of repetitions is
* omitted. * omitted.
* endianness: little or big endian
* @info_mask_separate: What information is to be exported that is specific to * @info_mask_separate: What information is to be exported that is specific to
* this channel. * this channel.
* @info_mask_shared_by_type: What information is to be exported that is shared * @info_mask_shared_by_type: What information is to be exported that is shared
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment