NTB: ntb_transport: fix all kernel-doc warnings
PATCH v2 1/1 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 <[email protected]>
Cc Jon Mason <[email protected]>
Cc Dave Jiang <[email protected]>
Cc Allen Hubbe <[email protected]>
Reviewed-by Dave Jiang <[email protected]>
---
v2: ad Dave's Reviewed-by;
rebase & resend;drivers/ntb/ntb_transport.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-)
drivers/ntb/ntb_transport.c +5 -3
@@ -377,6 +377,8 @@ EXPORT_SYMBOL_GPL(ntb_transport_unregist* @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/** * 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