Commit f4070482 authored Jan 18, 2024 by Randy Dunlap Committed by Jon Mason Sep 20, 2024

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>

parent 35c87cb8

drivers/ntb/ntb_transport.c

+5 −3

Original line number	Diff line number	Diff line
		@@ -377,6 +377,8 @@ EXPORT_SYMBOL_GPL(ntb_transport_unregister_client_dev);
		* @device_name: Name of NTB client device
		*
		* Register an NTB client device with the NTB transport layer
		*
		* Returns: %0 on success or -errno code on error
		*/
		int ntb_transport_register_client_dev(char *device_name)
		{
		@@ -1966,9 +1968,9 @@ static bool ntb_dma_filter_fn(struct dma_chan chan, void node)

		/**
		* ntb_transport_create_queue - Create a new NTB transport layer queue
		* @rx_handler: receive callback function
		* @tx_handler: transmit callback function
		* @event_handler: event callback function
		* @data: pointer for callback data
		* @client_dev: &struct device pointer
		* @handlers: pointer to various ntb queue (callback) handlers
		*
		* Create a new NTB transport layer queue and provide the queue with a callback
		* routine for both transmit and receive. The receive callback routine will be