Re: [PATCH v3 1/2] iio: add kernel-doc for field @owner

From: Jonathan Cameron
Date: Sun Jan 07 2018 - 11:13:37 EST


On Sun, 7 Jan 2018 08:56:05 +1100
"Tobin C. Harding" <me@xxxxxxxx> wrote:

> When building kernel documentation sphinx emits the following warning
>
> warning: No description found for parameter 'owner'
>
> Add description for struct member 'owner'.
>
> Signed-off-by: Tobin C. Harding <me@xxxxxxxx>
Applied to the togreg branch of iio.git and pushed out as testing for
the autobuilders to play with it.

Thanks,

Jonathan

> ---
> include/linux/iio/trigger.h | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/include/linux/iio/trigger.h b/include/linux/iio/trigger.h
> index 7d5e44518379..390789d43369 100644
> --- a/include/linux/iio/trigger.h
> +++ b/include/linux/iio/trigger.h
> @@ -43,6 +43,7 @@ struct iio_trigger_ops {
> /**
> * struct iio_trigger - industrial I/O trigger device
> * @ops: [DRIVER] operations structure
> + * @owner: [INTERN] owner of this driver module
> * @id: [INTERN] unique id number
> * @name: [DRIVER] unique name
> * @dev: [DRIVER] associated device (if relevant)