NTB: ntb_transport: fix all kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Fri, 19 Jan 2024 03:28:45 +0000 (19:28 -0800)
committerJon Mason <jdmason@kudzu.us>
Fri, 20 Sep 2024 14:50:38 +0000 (10:50 -0400)
commitf407048235a3ac626078139b0c5cf313b946eba2
tree3fc7876b72287ef2f10b69e56f1eaf5233609b20
parent35c87cb80d65859342611cbb7bd501d490452120
NTB: ntb_transport: fix all kernel-doc warnings

Fix all kernel-doc warnings in ntb_transport.c.

The function parameters for ntb_transport_create_queue() changed, so
update them in the kernel-doc comments.
Add a Returns: comment for ntb_transport_register_client_dev().

ntb_transport.c:382: warning: No description found for return value of 'ntb_transport_register_client_dev'
ntb_transport.c:1984: warning: Excess function parameter 'rx_handler' description in 'ntb_transport_create_queue'
ntb_transport.c:1984: warning: Excess function parameter 'tx_handler' description in 'ntb_transport_create_queue'
ntb_transport.c:1984: warning: Excess function parameter 'event_handler' description in 'ntb_transport_create_queue'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jon Mason <jdmason@kudzu.us>
Cc: Dave Jiang <dave.jiang@intel.com>
Cc: Allen Hubbe <allenbh@gmail.com>
Cc: ntb@lists.linux.dev
Reviewed-by: Dave Jiang <dave.jiang@intel.com>
Signed-off-by: Jon Mason <jdmason@kudzu.us>
drivers/ntb/ntb_transport.c