Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 04e7b3d7 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Cameron
Browse files

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: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
parent 9701b6e2

include/linux/iio/iio.h

+12 −12
Original line number Original line Diff line number Diff line
@@ -183,18 +183,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:		struct describing the scan type

 *			realbits:	Number of valid bits of data

 * @scan_type.sign:		's' or 'u' to specify signed or unsigned

 *			storagebits:	Realbits + padding

 * @scan_type.realbits:		Number of valid bits of data

 *			shift:		Shift right by this before masking out

 * @scan_type.storagebits:	Realbits + padding

 * @scan_type.shift:		Shift right by this before masking out

 *				realbits.

 *				realbits.

 *			repeat:		Number of times real/storage bits

 * @scan_type.repeat:		Number of times real/storage bits repeats.

 *					repeats. When the repeat element is

 *				When the repeat element is more than 1, then

 *					more than 1, then the type element in

 *				the type element in sysfs will show a repeat

 *					sysfs will show a repeat value.

 *				value. Otherwise, the number of repetitions

 *					Otherwise, the number of repetitions is

 *				is omitted.

 *					omitted.

 * @scan_type.endianness:	little or big endian

 *			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_separate_available: What availability information is to be

 * @info_mask_separate_available: What availability information is to be