iio: consumer.h: Fix kernel doc incosistency
authorLars-Peter Clausen <lars@metafoo.de>
Mon, 17 Sep 2012 12:17:00 +0000 (13:17 +0100)
committerJonathan Cameron <jic23@kernel.org>
Mon, 17 Sep 2012 20:41:26 +0000 (21:41 +0100)
commit45f010baa0292c367168b1f62d5494965b905b5d
treef183f6a41a1c88d342778cadc174d1321aef9fc4
parentc499d029d80534a01e858ce9fd1687f2042f7a86
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>
include/linux/iio/consumer.h