patches for DPDK stable branches
 help / color / mirror / Atom feed
From: Kevin Traynor <ktraynor@redhat.com>
To: stable@dpdk.org
Cc: alialnu@nvidia.com, david.marchand@redhat.com,
	Kevin Traynor <ktraynor@redhat.com>,
	Maxime Coquelin <maxime.coquelin@redhat.com>,
	Chenbo Xia <chenbo.xia@intel.com>
Subject: [PATCH 21.11] vhost: fix doxygen warnings
Date: Tue, 20 Dec 2022 12:37:12 +0000	[thread overview]
Message-ID: <20221220123712.239728-1-ktraynor@redhat.com> (raw)

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


             reply	other threads:[~2022-12-20 12:37 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-12-20 12:37 Kevin Traynor [this message]
2022-12-20 17:18 ` Kevin Traynor

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20221220123712.239728-1-ktraynor@redhat.com \
    --to=ktraynor@redhat.com \
    --cc=alialnu@nvidia.com \
    --cc=chenbo.xia@intel.com \
    --cc=david.marchand@redhat.com \
    --cc=maxime.coquelin@redhat.com \
    --cc=stable@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).