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

i3c: fix device.h kernel-doc warnings

Fix all kernel-doc warnings in <linux/i3c/device.h>:

include/linux/i3c/device.h:27: warning: contents before sections
include/linux/i3c/device.h:196: warning: Excess function parameter 'dev' description in 'dev_to_i3cdev'

Fixes: fa838c8ce537 ("i3c: move dev_to_i3cdev() to use container_of_const()")
Fixes: 3a379bbcea0a ("i3c: Add core I3C infrastructure")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Boris Brezillon <boris.brezillon@bootlin.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Alexandre Belloni <alexandre.belloni@bootlin.com>
Cc: linux-i3c@lists.infradead.org
Link: https://lore.kernel.org/r/20230213070324.1564-1-rdunlap@infradead.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Randy Dunlap and committed by
Greg Kroah-Hartman
007ed790 ade1229c

+7 -6
+7 -6
include/linux/i3c/device.h
··· 18 18 /** 19 19 * enum i3c_error_code - I3C error codes 20 20 * 21 + * @I3C_ERROR_UNKNOWN: unknown error, usually means the error is not I3C 22 + * related 23 + * @I3C_ERROR_M0: M0 error 24 + * @I3C_ERROR_M1: M1 error 25 + * @I3C_ERROR_M2: M2 error 26 + * 21 27 * These are the standard error codes as defined by the I3C specification. 22 28 * When -EIO is returned by the i3c_device_do_priv_xfers() or 23 29 * i3c_device_send_hdr_cmds() one can check the error code in 24 30 * &struct_i3c_priv_xfer.err or &struct i3c_hdr_cmd.err to get a better idea of 25 31 * what went wrong. 26 32 * 27 - * @I3C_ERROR_UNKNOWN: unknown error, usually means the error is not I3C 28 - * related 29 - * @I3C_ERROR_M0: M0 error 30 - * @I3C_ERROR_M1: M1 error 31 - * @I3C_ERROR_M2: M2 error 32 33 */ 33 34 enum i3c_error_code { 34 35 I3C_ERROR_UNKNOWN = 0, ··· 190 189 191 190 /** 192 191 * dev_to_i3cdev() - Returns the I3C device containing @dev 193 - * @dev: device object 192 + * @__dev: device object 194 193 * 195 194 * Return: a pointer to an I3C device object. 196 195 */