Re: [PATCH v2 3/6] iio: adc: mcp320x: Document struct mcp320x

[Jonathan Cameron <jic23@kernel.org>]

On Sat, 9 Sep 2017 20:32:41 +0200
Lukas Wunner <lukas@wunner.de> wrote:

> Signed-off-by: Lukas Wunner <lukas@wunner.de>

Applied.
> ---
> Changes since v1:
> - Move kerneldoc to separate patch. (Jonathan)
> 
>  drivers/iio/adc/mcp320x.c | 11 +++++++++++
>  1 file changed, 11 insertions(+)
> 
> diff --git a/drivers/iio/adc/mcp320x.c b/drivers/iio/adc/mcp320x.c
> index bf4794009413..32859188d653 100644
> --- a/drivers/iio/adc/mcp320x.c
> +++ b/drivers/iio/adc/mcp320x.c
> @@ -59,6 +59,17 @@ struct mcp320x_chip_info {
>  	unsigned int resolution;
>  };
>  
> +/**
> + * struct mcp320x - Microchip SPI ADC instance
> + * @spi: SPI slave (parent of the IIO device)
> + * @msg: SPI message to select a channel and receive a value from the ADC
> + * @transfer: SPI transfers used by @msg
> + * @reg: regulator generating Vref
> + * @lock: protects read sequences
> + * @chip_info: ADC properties
> + * @tx_buf: buffer for @transfer[0] (not used on single-channel converters)
> + * @rx_buf: buffer for @transfer[1]
> + */
>  struct mcp320x {
>  	struct spi_device *spi;
>  	struct spi_message msg;