i2c: axxia: use 'struct' for kernel-doc notation

Message ID 20230113063756.14071-1-rdunlap@infradead.org
State New
Headers
Series i2c: axxia: use 'struct' for kernel-doc notation |

Commit Message

Randy Dunlap Jan. 13, 2023, 6:37 a.m. UTC
  Add "struct" to prevent this kernel-doc warning:

drivers/i2c/busses/i2c-axxia.c:135: warning: cannot understand function prototype: 'struct axxia_i2c_dev '

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Krzysztof Adamski <krzysztof.adamski@nokia.com>
Cc: Wolfram Sang <wsa@kernel.org>
Cc: linux-i2c@vger.kernel.org
---
 drivers/i2c/busses/i2c-axxia.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Wolfram Sang Jan. 20, 2023, 9:20 a.m. UTC | #1
On Thu, Jan 12, 2023 at 10:37:56PM -0800, Randy Dunlap wrote:
> Add "struct" to prevent this kernel-doc warning:
> 
> drivers/i2c/busses/i2c-axxia.c:135: warning: cannot understand function prototype: 'struct axxia_i2c_dev '
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Krzysztof Adamski <krzysztof.adamski@nokia.com>
> Cc: Wolfram Sang <wsa@kernel.org>
> Cc: linux-i2c@vger.kernel.org

Applied to for-current, thanks!

@Krzysztof: I hope you don't mind, I want to send out for-current soon.
  

Patch

diff -- a/drivers/i2c/busses/i2c-axxia.c b/drivers/i2c/busses/i2c-axxia.c
--- a/drivers/i2c/busses/i2c-axxia.c
+++ b/drivers/i2c/busses/i2c-axxia.c
@@ -118,7 +118,7 @@ 
 #define SDA_HOLD_TIME		0x90
 
 /**
- * axxia_i2c_dev - I2C device context
+ * struct axxia_i2c_dev - I2C device context
  * @base: pointer to register struct
  * @msg: pointer to current message
  * @msg_r: pointer to current read message (sequence transfer)