Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

i2c: xiic: Fix kerneldoc warnings

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>

authored by

Shubhrajyoti Datta and committed by
Wolfram Sang
bcc156e2 53aaaa5d

+2
+2
drivers/i2c/busses/i2c-xiic.c
··· 46 46 47 47 /** 48 48 * struct xiic_i2c - Internal representation of the XIIC I2C bus 49 + * @dev: Pointer to device structure 49 50 * @base: Memory base of the HW registers 50 51 * @wait: Wait queue for callers 51 52 * @adap: Kernel adapter representation ··· 58 57 * @rx_msg: Current RX message 59 58 * @rx_pos: Position within current RX message 60 59 * @endianness: big/little-endian byte order 60 + * @clk: Pointer to AXI4-lite input clock 61 61 */ 62 62 struct xiic_i2c { 63 63 struct device *dev;