Commit 45f010ba authored Sep 17, 2012 by Lars-Peter Clausen Committed by Jonathan Cameron Sep 17, 2012

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>

parent c499d029

include/linux/iio/consumer.h

+2 −2

Original line number	Diff line number	Diff line
		@@ -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.
		*