diff options
| author | Lars-Peter Clausen | 2012-09-17 13:17:00 +0100 |
|---|---|---|
| committer | Jonathan Cameron | 2012-09-17 21:41:26 +0100 |
| commit | 45f010baa0292c367168b1f62d5494965b905b5d (patch) | |
| tree | f183f6a41a1c88d342778cadc174d1321aef9fc4 /include/linux/iio | |
| parent | c499d029d80534a01e858ce9fd1687f2042f7a86 (diff) | |
iio: consumer.h: Fix kernel doc incosistency
For the iio_read_channel_raw and iio_read_channel_scale the kerneldoc comment
refers to an argument called "channel", while the argument is called "chan" in
the function signature. This leads to the following warnings from kerneldoc:
Warning(include/linux/iio/consumer.h:71): No description found for parameter 'chan'
Warning(include/linux/iio/consumer.h:71): Excess function parameter 'channel' description in 'iio_read_channel_raw'
Warning(include/linux/iio/consumer.h:109): No description found for parameter 'chan'
Warning(include/linux/iio/consumer.h:109): Excess function parameter 'channel' description in 'iio_read_channel_scale'
This patch fixes the warnings by naming them consistently.
Signed-off-by: Lars-Peter Clausen <lars@metafoo.de>
Signed-off-by: Jonathan Cameron <jic23@kernel.org>
Diffstat (limited to 'include/linux/iio')
| -rw-r--r-- | include/linux/iio/consumer.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/linux/iio/consumer.h b/include/linux/iio/consumer.h index 06ab4ec56c37..62118dd707d7 100644 --- a/include/linux/iio/consumer.h +++ b/include/linux/iio/consumer.h @@ -61,7 +61,7 @@ void iio_channel_release_all(struct iio_channel *chan); /** * iio_read_channel_raw() - read from a given channel - * @channel: The channel being queried. + * @chan: The channel being queried. * @val: Value read back. * * Note raw reads from iio channels are in adc counts and hence @@ -82,7 +82,7 @@ int iio_get_channel_type(struct iio_channel *channel, /** * iio_read_channel_scale() - read the scale value for a channel - * @channel: The channel being queried. + * @chan: The channel being queried. * @val: First part of value read back. * @val2: Second part of value read back. * |