Hi Shubhrajyoti,
On 01/11/19 14:39, Shubhrajyoti Datta wrote:
> Fix the below warning by adding the description of clock and dev.
>
> drivers/i2c/busses/i2c-xiic.c:57: info: Scanning doc for struct xiic_i2c
> drivers/i2c/busses/i2c-xiic.c:84: warning: Function parameter or member
> 'dev' not described in 'xiic_i2c'
> drivers/i2c/busses/i2c-xiic.c:84: warning: Function parameter or member
> 'clk' not described in 'xiic_i2c'
>
> Signed-off-by: Shubhrajyoti Datta <shubhrajyoti.datta@xxxxxxxxxx>
> ---
> drivers/i2c/busses/i2c-xiic.c | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/drivers/i2c/busses/i2c-xiic.c b/drivers/i2c/busses/i2c-xiic.c
> index 0c51c0f..e212a9c 100644
> --- a/drivers/i2c/busses/i2c-xiic.c
> +++ b/drivers/i2c/busses/i2c-xiic.c
> @@ -55,6 +55,7 @@ enum xiic_endian {
>
> /**
> * struct xiic_i2c - Internal representation of the XIIC I2C bus
> + * @dev: Pointer to device structure
> * @base: Memory base of the HW registers
> * @wait: Wait queue for callers
> * @adap: Kernel adapter representation
> @@ -66,6 +67,7 @@ enum xiic_endian {
> * @rx_msg: Current RX message
> * @rx_pos: Position within current RX message
> * @endianness: big/little-endian byte order
> + * @clk: Pointer to struct clk
'Pointer to struct clk' does not say anything that is not already
obvious from the 'struct clk *clk' below. I understand you are simply
fixing a kernel-doc warning, but I'd rather document this field as
'Input clock' or 'AXI4-Lite input clock', which gives at least a bit of
extra information (even though not much more, because clock management
is really simple for this device).
Just my 2c,
--
Luca
