PATCH] iio: Fix some documentation warnings (f00fd7ae) · Commits · 戴 / test

The kerneldoc description for the trig_readonly field of struct iio_dev lacked a colon, leading to this doc build warning: ./include/linux/iio/iio.h:603: warning: No description found for parameter 'trig_readonly' A similar issue for iio_trigger_set_immutable() in trigger.h yielded: ./include/linux/iio/trigger.h:151: warning: No description found for parameter 'indio_dev' ./include/linux/iio/trigger.h:151: warning: No description found for parameter 'trig' Fix the formatting and silence the warnings. Signed-off-by:

Jonathan Corbet <corbet@lwn.net> Signed-off-by:

Jonathan Cameron <Jonathan.Cameron@huawei.com>

include/linux/iio/iio.h

+1 −1

Original line number	Diff line number	Diff line
		@@ -535,7 +535,7 @@ struct iio_buffer_setup_ops {
		* @scan_timestamp: [INTERN] set if any buffers have requested timestamp
		* @scan_index_timestamp:[INTERN] cache of the index to the timestamp
		* @trig: [INTERN] current device trigger (buffer modes)
		* @trig_readonly [INTERN] mark the current trigger immutable
		* @trig_readonly: [INTERN] mark the current trigger immutable
		* @pollfunc: [DRIVER] function run on trigger being received
		* @pollfunc_event: [DRIVER] function run on events trigger being received
		* @channels: [DRIVER] channel specification structure table

include/linux/iio/trigger.h

+2 −2

Original line number	Diff line number	Diff line
		@@ -144,8 +144,8 @@ void devm_iio_trigger_unregister(struct device *dev,
		/**
		* iio_trigger_set_immutable() - set an immutable trigger on destination
		*
		* @indio_dev - IIO device structure containing the device
		* @trig - trigger to assign to device
		* @indio_dev: IIO device structure containing the device
		* @trig: trigger to assign to device
		*
		**/
		int iio_trigger_set_immutable(struct iio_dev indio_dev, struct iio_trigger trig);

Admin message