[PATCH 21.11] vhost: fix doxygen warnings

[PATCH 21.11] vhost: fix doxygen warnings

[Kevin Traynor]

Doxygen 1.9.5 gives a false positive warnings [1]
for @params on function pointer params.

This is fixed in doxygen 1.9.6 but Fedora 37 uses
1.9.5 at present.

Remove the @param but keep the comments for info in
the header file as a workaround until 1.9.6 is more
widely deployed.

[1]
/lib/vhost/rte_vhost_async.h:48: warning:
rte_vhost_async_channel_ops::transfer_data
has @param documentation sections but no arguments
/lib/vhost/rte_vhost_async.h:68: warning:
rte_vhost_async_channel_ops::check_completed_copies
has @param documentation sections but no arguments

Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
---
 lib/vhost/rte_vhost_async.h | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/lib/vhost/rte_vhost_async.h b/lib/vhost/rte_vhost_async.h
index d20152ca7a..159b9b0889 100644
--- a/lib/vhost/rte_vhost_async.h
+++ b/lib/vhost/rte_vhost_async.h
@@ -48,13 +48,13 @@ struct rte_vhost_async_channel_ops {
 	 * instruct async engines to perform copies for a batch of packets
 	 *
-	 * @param vid
+	 *  vid
 	 *  id of vhost device to perform data copies
-	 * @param queue_id
+	 *  queue_id
 	 *  queue id to perform data copies
-	 * @param iov_iter
+	 *  iov_iter
 	 *  an array of IOV iterators
-	 * @param opaque_data
+	 *  opaque_data
 	 *  opaque data pair sending to DMA engine
-	 * @param count
+	 *  count
 	 *  number of elements in the "descs" array
 	 * @return
@@ -67,11 +67,11 @@ struct rte_vhost_async_channel_ops {
 	/**
 	 * check copy-completed packets from the async engine
-	 * @param vid
+	 *  vid
 	 *  id of vhost device to check copy completion
-	 * @param queue_id
+	 *  queue_id
 	 *  queue id to check copy completion
-	 * @param opaque_data
+	 *  opaque_data
 	 *  buffer to receive the opaque data pair from DMA engine
-	 * @param max_packets
+	 *  max_packets
 	 *  max number of packets could be completed
 	 * @return
-- 
2.38.1

Re: [PATCH 21.11] vhost: fix doxygen warnings

[Kevin Traynor]

On 20/12/2022 12:37, Kevin Traynor wrote:
> Doxygen 1.9.5 gives a false positive warnings [1]
> for @params on function pointer params.
> 
> This is fixed in doxygen 1.9.6 but Fedora 37 uses
> 1.9.5 at present.
> 
> Remove the @param but keep the comments for info in
> the header file as a workaround until 1.9.6 is more
> widely deployed.
> 
> [1]
> /lib/vhost/rte_vhost_async.h:48: warning:
> rte_vhost_async_channel_ops::transfer_data
> has @param documentation sections but no arguments
> /lib/vhost/rte_vhost_async.h:68: warning:
> rte_vhost_async_channel_ops::check_completed_copies
> has @param documentation sections but no arguments
> 
> Signed-off-by: Kevin Traynor<ktraynor@redhat.com>
> ---

Pushed to 21.11 branch for 21.11.3. Thanks.