All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH 1/4] iio: consumer.h: Fix kernel doc incosistency
@ 2012-09-14 15:21 Lars-Peter Clausen
  2012-09-14 15:21 ` [PATCH 2/4] iio: Introduce a new fractional value type Lars-Peter Clausen
                   ` (3 more replies)
  0 siblings, 4 replies; 9+ messages in thread
From: Lars-Peter Clausen @ 2012-09-14 15:21 UTC (permalink / raw)
  To: Jonathan Cameron; +Cc: linux-iio, Milo Kim, anish kumar, Lars-Peter Clausen

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>
---
 include/linux/iio/consumer.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/iio/consumer.h b/include/linux/iio/consumer.h
index 06ab4ec..27759ac3 100644
--- a/include/linux/iio/consumer.h
+++ b/include/linux/iio/consumer.h
@@ -67,7 +67,7 @@ void iio_channel_release_all(struct iio_channel *chan);
  * Note raw reads from iio channels are in adc counts and hence
  * scale will need to be applied if standard units required.
  */
-int iio_read_channel_raw(struct iio_channel *chan,
+int iio_read_channel_raw(struct iio_channel *channel,
 			 int *val);
 
 /**
@@ -90,7 +90,7 @@ int iio_get_channel_type(struct iio_channel *channel,
  * as IIO_VAL_INT_PLUS_MICRO telling us we have a value of val
  * + val2/1e6
  */
-int iio_read_channel_scale(struct iio_channel *chan, int *val,
+int iio_read_channel_scale(struct iio_channel *channel, int *val,
 			   int *val2);
 
 #endif
-- 
1.7.10.4


^ permalink raw reply related	[flat|nested] 9+ messages in thread

end of thread, other threads:[~2012-09-15  9:35 UTC | newest]

Thread overview: 9+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2012-09-14 15:21 [PATCH 1/4] iio: consumer.h: Fix kernel doc incosistency Lars-Peter Clausen
2012-09-14 15:21 ` [PATCH 2/4] iio: Introduce a new fractional value type Lars-Peter Clausen
2012-09-15  9:13   ` Jonathan Cameron
2012-09-14 15:21 ` [PATCH 3/4] iio:inkern: Add function to read the processed value Lars-Peter Clausen
2012-09-15  9:26   ` Jonathan Cameron
2012-09-15  9:31     ` Lars-Peter Clausen
2012-09-15  9:35       ` Jonathan Cameron
2012-09-14 15:21 ` [PATCH 4/4] staging:iio:hwmon bridge: Use iio_read_channel_processed Lars-Peter Clausen
2012-09-15  9:10 ` [PATCH 1/4] iio: consumer.h: Fix kernel doc incosistency Jonathan Cameron

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.