]> git.ipfire.org Git - thirdparty/linux.git/commit
IB/rdmavt: rdmavt_qp.h: clean up kernel-doc comments
authorRandy Dunlap <rdunlap@infradead.org>
Wed, 5 Nov 2025 04:51:27 +0000 (20:51 -0800)
committerLeon Romanovsky <leon@kernel.org>
Thu, 6 Nov 2025 07:23:23 +0000 (02:23 -0500)
commit512c83265796d613f21255c766839eaed1c1cc79
treee2c14d950214bd1ee09dec8d957a322efe0812db
parent7196156b0ce3dc4cdbda5c09897708b2e1081de1
IB/rdmavt: rdmavt_qp.h: clean up kernel-doc comments

Correct the kernel-doc comments format to avoid around 35 kernel-doc
warnings:

- use struct keyword to introduce struct kernel-doc comments
- use correct variable name for some struct members
- use correct function name in comments for some functions
- fix spelling in a few comments
- use a ':' instead of '-' to separate struct members from their
  descriptions
- add a function name heading for rvt_div_mtu()

This leaves one struct member that is not described:
rdmavt_qp.h:206: warning: Function parameter or struct member 'wq'
 not described in 'rvt_krwq'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://patch.msgid.link/20251105045127.106822-1-rdunlap@infradead.org
Signed-off-by: Leon Romanovsky <leon@kernel.org>
include/rdma/rdmavt_qp.h