[PATCH] NTB: ntb_transport: fix all kernel-doc warnings

[PATCH] NTB: ntb_transport: fix all kernel-doc warnings

[Randy Dunlap]

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
---
 drivers/ntb/ntb_transport.c |    8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff -- a/drivers/ntb/ntb_transport.c b/drivers/ntb/ntb_transport.c
--- a/drivers/ntb/ntb_transport.c
+++ b/drivers/ntb/ntb_transport.c
@@ -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

Re: [PATCH] NTB: ntb_transport: fix all kernel-doc warnings

[Dave Jiang]

On 1/18/24 20:28, Randy Dunlap wrote:
> 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>

Thanks Randy!

> ---
>  drivers/ntb/ntb_transport.c |    8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)
> 
> diff -- a/drivers/ntb/ntb_transport.c b/drivers/ntb/ntb_transport.c
> --- a/drivers/ntb/ntb_transport.c
> +++ b/drivers/ntb/ntb_transport.c
> @@ -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
>