From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from out4-smtp.messagingengine.com (out4-smtp.messagingengine.com [66.111.4.28]) by dpdk.org (Postfix) with ESMTP id 4D7231B1BC for ; Wed, 24 Jan 2018 16:41:48 +0100 (CET) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id E7E2E22714; Wed, 24 Jan 2018 10:41:47 -0500 (EST) Received: from frontend1 ([10.202.2.160]) by compute1.internal (MEProxy); Wed, 24 Jan 2018 10:41:47 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=fridaylinux.org; h=cc:date:from:in-reply-to:message-id:references:subject:to :x-me-sender:x-me-sender:x-sasl-enc; s=fm1; bh=z/pjP8CGfnPWa4q/t XT6NjzuamFE3dVC1QJCnsJHdp8=; b=NHG1R8cLcTjybDMeTHiBwtotPynwhlPnp 374mGaC/78PTW/Cp4noIorag0XRb7z5RC3RF9e/ZpxIdz2ylXzy2fVSjU5EbMOu5 J5hDgVH9HUepevI00huaB0S6wtyKFF/LPTBVEm5T3Aso76voif56gjUQTV1jr3tV sTqsisL2KZ7Q6S5JAsgfY05vo7PHAroIixIVYcjN+NPwtdbxbzj9yx9Pe09QkJ/H JA6s58Ex82dmGr6dGkwZYPfs0/plfkJs/SpxgiflZPIM8G/ooN2L9+xZYb2OCDIJ wNHkse3Gwen+Gy/FSxRL/WTeGXVBhXI/d6NkweiS3bRAaHYU394ww== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:date:from:in-reply-to:message-id :references:subject:to:x-me-sender:x-me-sender:x-sasl-enc; s= fm1; bh=z/pjP8CGfnPWa4q/tXT6NjzuamFE3dVC1QJCnsJHdp8=; b=A7SGlmW9 bu4tgtKpHRux8s+lBMrUVMdl5Vn3a5sF+eYLBSjf6hTdwr/cs6yZLp4V+fkA9T0/ HYB6De8DUSqRh2J21M1aL4firAs7OR88iGWjhUhtiXYBzNtvS8sW49I4AtVhYH43 IUu/vWJyF1ELo3DWA8xH2aWEDQXrXxy8ZrpSEhZ7S0gcBFS/RDrJx0f+Dl5HQJvC sRWlA6idKt8+s33xG/NGO1wo9jVt1XwtB/lgzT+QKt9smADIGcSiaUIMpWbV4hs+ i2fyFjIz3Z52S1l6eWJbLx4NaHraHwn5g+YAXodAxvJ1KzKP47QmB/5Q4ZScghDx kMVtBhf4YmI7yA== X-ME-Sender: Received: from localhost.localdomain (unknown [115.150.27.206]) by mail.messagingengine.com (Postfix) with ESMTPA id CA1AC7E3D4; Wed, 24 Jan 2018 10:41:45 -0500 (EST) From: Yuanhan Liu To: Pavan Nikhilesh Cc: Kevin Laatz , dpdk stable Date: Wed, 24 Jan 2018 23:33:20 +0800 Message-Id: <1516808026-25523-132-git-send-email-yliu@fridaylinux.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1516808026-25523-1-git-send-email-yliu@fridaylinux.org> References: <1516808026-25523-1-git-send-email-yliu@fridaylinux.org> Subject: [dpdk-stable] patch 'eventdev: fix doxygen comments' has been queued to LTS release 17.11.1 X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 24 Jan 2018 15:41:48 -0000 Hi, FYI, your patch has been queued to LTS release 17.11.1 Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet. It will be pushed if I get no objections before 01/26/18. So please shout if anyone has objections. Thanks. --yliu --- >>From 631ecfdf369397f1e04d79aabf1f349036ce9e07 Mon Sep 17 00:00:00 2001 From: Pavan Nikhilesh Date: Sat, 9 Dec 2017 20:10:07 +0530 Subject: [PATCH] eventdev: fix doxygen comments [ upstream commit aa01e4cfcf5235ea6c0d43182dc1742fcc8cae75 ] Fix doxygen return values and indentation. Fixes: 64103dbcd673 ("eventdev: add dev attribute get function") Signed-off-by: Pavan Nikhilesh Acked-by: Kevin Laatz --- lib/librte_eventdev/rte_eventdev.h | 50 ++++++++++++++++++++++---------------- 1 file changed, 29 insertions(+), 21 deletions(-) diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h index 9134b49..eb1024d 100644 --- a/lib/librte_eventdev/rte_eventdev.h +++ b/lib/librte_eventdev/rte_eventdev.h @@ -421,9 +421,9 @@ rte_event_dev_info_get(uint8_t dev_id, struct rte_event_dev_info *dev_info); * @param[out] attr_value A pointer that will be filled in with the attribute * value if successful. * - * @retval 0 Successfully retrieved attribute value - * -EINVAL Invalid device or *attr_id* provided, or *attr_value* - * is NULL + * @return + * - 0: Successfully retrieved attribute value + * - -EINVAL: Invalid device or *attr_id* provided, or *attr_value* is NULL */ int rte_event_dev_attr_get(uint8_t dev_id, uint32_t attr_id, @@ -641,18 +641,22 @@ rte_event_queue_setup(uint8_t dev_id, uint8_t queue_id, /** * Get an attribute from a queue. * - * @param dev_id Eventdev id - * @param queue_id Eventdev queue id - * @param attr_id The attribute ID to retrieve - * @param[out] attr_value A pointer that will be filled in with the attribute - * value if successful + * @param dev_id + * Eventdev id + * @param queue_id + * Eventdev queue id + * @param attr_id + * The attribute ID to retrieve + * @param[out] attr_value + * A pointer that will be filled in with the attribute value if successful * - * @retval 0 Successfully returned value - * -EINVAL invalid device, queue or attr_id provided, or attr_value - * was NULL - * -EOVERFLOW returned when attr_id is set to - * RTE_EVENT_QUEUE_ATTR_SCHEDULE_TYPE and event_queue_cfg is set to - * RTE_EVENT_QUEUE_CFG_ALL_TYPES + * @return + * - 0: Successfully returned value + * - -EINVAL: invalid device, queue or attr_id provided, or attr_value was + * NULL + * - -EOVERFLOW: returned when attr_id is set to + * RTE_EVENT_QUEUE_ATTR_SCHEDULE_TYPE and event_queue_cfg is set to + * RTE_EVENT_QUEUE_CFG_ALL_TYPES */ int rte_event_queue_attr_get(uint8_t dev_id, uint8_t queue_id, uint32_t attr_id, @@ -755,14 +759,18 @@ rte_event_port_setup(uint8_t dev_id, uint8_t port_id, /** * Get an attribute from a port. * - * @param dev_id Eventdev id - * @param port_id Eventdev port id - * @param attr_id The attribute ID to retrieve - * @param[out] attr_value A pointer that will be filled in with the attribute - * value if successful + * @param dev_id + * Eventdev id + * @param port_id + * Eventdev port id + * @param attr_id + * The attribute ID to retrieve + * @param[out] attr_value + * A pointer that will be filled in with the attribute value if successful * - * @retval 0 Successfully returned value - * -EINVAL Invalid device, port or attr_id, or attr_value was NULL + * @return + * - 0: Successfully returned value + * - (-EINVAL) Invalid device, port or attr_id, or attr_value was NULL */ int rte_event_port_attr_get(uint8_t dev_id, uint8_t port_id, uint32_t attr_id, -- 2.7.4