Skip to content

Commit 04e7b3d

Browse files
mchehabjic23
authored andcommitted
iio: iio.h: use nested struct support on kernel-doc markup
Solve those Sphinx warnings: ./include/linux/iio/iio.h:270: warning: Function parameter or member 'scan_type.sign' not described in 'iio_chan_spec' ./include/linux/iio/iio.h:270: warning: Function parameter or member 'scan_type.realbits' not described in 'iio_chan_spec' ./include/linux/iio/iio.h:270: warning: Function parameter or member 'scan_type.storagebits' not described in 'iio_chan_spec' ./include/linux/iio/iio.h:270: warning: Function parameter or member 'scan_type.shift' not described in 'iio_chan_spec' ./include/linux/iio/iio.h:270: warning: Function parameter or member 'scan_type.repeat' not described in 'iio_chan_spec' ./include/linux/iio/iio.h:270: warning: Function parameter or member 'scan_type.endianness' not described in 'iio_chan_spec' ./include/linux/iio/iio.h:191: WARNING: Unexpected indentation. ./include/linux/iio/iio.h:192: WARNING: Block quote ends without a blank line; unexpected unindent. ./include/linux/iio/iio.h:198: WARNING: Definition list ends without a blank line; unexpected unindent. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Jonathan Cameron <[email protected]>
1 parent 9701b6e commit 04e7b3d

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

include/linux/iio/iio.h

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -183,18 +183,18 @@ struct iio_event_spec {
183183
* @address: Driver specific identifier.
184184
* @scan_index: Monotonic index to give ordering in scans when read
185185
* from a buffer.
186-
* @scan_type: sign: 's' or 'u' to specify signed or unsigned
187-
* realbits: Number of valid bits of data
188-
* storagebits: Realbits + padding
189-
* shift: Shift right by this before masking out
190-
* realbits.
191-
* repeat: Number of times real/storage bits
192-
* repeats. When the repeat element is
193-
* more than 1, then the type element in
194-
* sysfs will show a repeat value.
195-
* Otherwise, the number of repetitions is
196-
* omitted.
197-
* endianness: little or big endian
186+
* @scan_type: struct describing the scan type
187+
* @scan_type.sign: 's' or 'u' to specify signed or unsigned
188+
* @scan_type.realbits: Number of valid bits of data
189+
* @scan_type.storagebits: Realbits + padding
190+
* @scan_type.shift: Shift right by this before masking out
191+
* realbits.
192+
* @scan_type.repeat: Number of times real/storage bits repeats.
193+
* When the repeat element is more than 1, then
194+
* the type element in sysfs will show a repeat
195+
* value. Otherwise, the number of repetitions
196+
* is omitted.
197+
* @scan_type.endianness: little or big endian
198198
* @info_mask_separate: What information is to be exported that is specific to
199199
* this channel.
200200
* @info_mask_separate_available: What availability information is to be

0 commit comments

Comments
 (0)