From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 342EFA0545 for ; Tue, 20 Dec 2022 13:37:27 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 166E940685; Tue, 20 Dec 2022 13:37:27 +0100 (CET) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mails.dpdk.org (Postfix) with ESMTP id A9B1440395 for ; Tue, 20 Dec 2022 13:37:25 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1671539845; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=Xx1uQbiB3xB1Ttv/Qde4AuhGsdoyQ/Dbk5dRkXnKI/E=; b=EQph7uIhYnYFjBiNjfujyr6poQKm86BPrsrXdt9KWSde0UxvhJ+tPiU4A5etuaRlLtGqLa wbsWzf5lJuoknePlYIQcvCexG4IdyZaysZY3XUjL1zUcptQ2FOzdoMzqj6fkPQvFhxIpdo NTRgC/B6lvOpAYeVXJwQCoFjwfyctMs= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-589-pZXMfeW9Od6YgIFXV3ji9Q-1; Tue, 20 Dec 2022 07:37:22 -0500 X-MC-Unique: pZXMfeW9Od6YgIFXV3ji9Q-1 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.rdu2.redhat.com [10.11.54.3]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 8FD86183B3C1; Tue, 20 Dec 2022 12:37:21 +0000 (UTC) Received: from rh.redhat.com (unknown [10.39.192.37]) by smtp.corp.redhat.com (Postfix) with ESMTP id 1C5A1111DCE1; Tue, 20 Dec 2022 12:37:19 +0000 (UTC) From: Kevin Traynor To: stable@dpdk.org Cc: alialnu@nvidia.com, david.marchand@redhat.com, Kevin Traynor , Maxime Coquelin , Chenbo Xia Subject: [PATCH 21.11] vhost: fix doxygen warnings Date: Tue, 20 Dec 2022 12:37:12 +0000 Message-Id: <20221220123712.239728-1-ktraynor@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.3 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII"; x-default=true X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org 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 --- 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