i2c: xiic: Fix kerneldoc warnings
authorShubhrajyoti Datta <shubhrajyoti.datta@xilinx.com>
Tue, 5 Nov 2019 05:27:45 +0000 (10:57 +0530)
committerWolfram Sang <wsa@the-dreams.de>
Mon, 11 Nov 2019 19:43:07 +0000 (20:43 +0100)
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@xilinx.com>
Signed-off-by: Michal Simek <michal.simek@xilinx.com>
Reviewed-by: Luca Ceresoli <luca@lucaceresoli.net>
Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
drivers/i2c/busses/i2c-xiic.c

index 37b3b93..d8d49f1 100644 (file)
@@ -46,6 +46,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
@@ -57,6 +58,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 AXI4-lite input clock
  */
 struct xiic_i2c {
        struct device           *dev;