diff options
author | Lars-Peter Clausen <lars@metafoo.de> | 2012-09-17 08:17:00 -0400 |
---|---|---|
committer | Jonathan Cameron <jic23@kernel.org> | 2012-09-17 16:41:26 -0400 |
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); | |||
61 | 61 | ||
62 | /** | 62 | /** |
63 | * iio_read_channel_raw() - read from a given channel | 63 | * iio_read_channel_raw() - read from a given channel |
64 | * @channel: The channel being queried. | 64 | * @chan: The channel being queried. |
65 | * @val: Value read back. | 65 | * @val: Value read back. |
66 | * | 66 | * |
67 | * Note raw reads from iio channels are in adc counts and hence | 67 | * 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, | |||
82 | 82 | ||
83 | /** | 83 | /** |
84 | * iio_read_channel_scale() - read the scale value for a channel | 84 | * iio_read_channel_scale() - read the scale value for a channel |
85 | * @channel: The channel being queried. | 85 | * @chan: The channel being queried. |
86 | * @val: First part of value read back. | 86 | * @val: First part of value read back. |
87 | * @val2: Second part of value read back. | 87 | * @val2: Second part of value read back. |
88 | * | 88 | * |