Skip to content

Commit f00fd7a

Browse files
Jonathan Corbetjic23
authored andcommitted
PATCH] iio: Fix some documentation warnings
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 <[email protected]> Signed-off-by: Jonathan Cameron <[email protected]>
1 parent 50dbe1f commit f00fd7a

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

include/linux/iio/iio.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -535,7 +535,7 @@ struct iio_buffer_setup_ops {
535535
* @scan_timestamp: [INTERN] set if any buffers have requested timestamp
536536
* @scan_index_timestamp:[INTERN] cache of the index to the timestamp
537537
* @trig: [INTERN] current device trigger (buffer modes)
538-
* @trig_readonly [INTERN] mark the current trigger immutable
538+
* @trig_readonly: [INTERN] mark the current trigger immutable
539539
* @pollfunc: [DRIVER] function run on trigger being received
540540
* @pollfunc_event: [DRIVER] function run on events trigger being received
541541
* @channels: [DRIVER] channel specification structure table

include/linux/iio/trigger.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,8 +144,8 @@ void devm_iio_trigger_unregister(struct device *dev,
144144
/**
145145
* iio_trigger_set_immutable() - set an immutable trigger on destination
146146
*
147-
* @indio_dev - IIO device structure containing the device
148-
* @trig - trigger to assign to device
147+
* @indio_dev: IIO device structure containing the device
148+
* @trig: trigger to assign to device
149149
*
150150
**/
151151
int iio_trigger_set_immutable(struct iio_dev *indio_dev, struct iio_trigger *trig);

0 commit comments

Comments
 (0)