From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 1FD46A0561 for ; Mon, 20 Apr 2020 01:40:05 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id D48961D15B; Mon, 20 Apr 2020 01:40:03 +0200 (CEST) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by dpdk.org (Postfix) with ESMTP id 101D71C433; Mon, 20 Apr 2020 01:40:00 +0200 (CEST) IronPort-SDR: FwyOfjsJaI4mMsdrKyVBZTJ8AKgx9dvQT32USLN9N6Jc34/67BNhUHPpG09VOhvGfkclFHrBlg 0DLQFtVJdLAg== X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga004.fm.intel.com ([10.253.24.48]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Apr 2020 16:39:59 -0700 IronPort-SDR: Ln2akzHYHhp8XTawLlEKKSFlHk3KjsDodyAkKlTurto7zpSajlLbiV2I5yBQPOPzZwI1ZPy+TQ moKv2p7c4AdQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.72,404,1580803200"; d="scan'208";a="279066472" Received: from skx-5gnr-sc12-4.sc.intel.com ([172.25.69.210]) by fmsmga004.fm.intel.com with ESMTP; 19 Apr 2020 16:39:59 -0700 From: Nicolas Chautru To: dev@dpdk.org, akhil.goyal@nxp.com Cc: stable@dpdk.org, Nicolas Chautru Date: Sun, 19 Apr 2020 16:39:48 -0700 Message-Id: <1587339588-243777-2-git-send-email-nicolas.chautru@intel.com> X-Mailer: git-send-email 1.8.3.1 In-Reply-To: <1587339588-243777-1-git-send-email-nicolas.chautru@intel.com> References: <1587339588-243777-1-git-send-email-nicolas.chautru@intel.com> Subject: [dpdk-stable] [PATCH v2] bbdev: doxygen update only 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: , Errors-To: stable-bounces@dpdk.org Sender: "stable" Fixes: 4935e1e9f76e ("bbdev: introduce wireless base band device lib") Several doxygen markup were incorrect in header files. Signed-off-by: Nicolas Chautru --- lib/librte_bbdev/rte_bbdev.h | 16 ++++++++-------- lib/librte_bbdev/rte_bbdev_op.h | 16 ++++++++-------- lib/librte_bbdev/rte_bbdev_pmd.h | 14 +++++++------- 3 files changed, 23 insertions(+), 23 deletions(-) diff --git a/lib/librte_bbdev/rte_bbdev.h b/lib/librte_bbdev/rte_bbdev.h index 38d9d50..ecd95a8 100644 --- a/lib/librte_bbdev/rte_bbdev.h +++ b/lib/librte_bbdev/rte_bbdev.h @@ -442,21 +442,21 @@ struct rte_bbdev_data { * these fields, but should only write to the *_ops fields. */ struct __rte_cache_aligned rte_bbdev { - /**< Enqueue encode function */ + /** Enqueue encode function */ rte_bbdev_enqueue_enc_ops_t enqueue_enc_ops; - /**< Enqueue decode function */ + /** Enqueue decode function */ rte_bbdev_enqueue_dec_ops_t enqueue_dec_ops; - /**< Dequeue encode function */ + /** Dequeue encode function */ rte_bbdev_dequeue_enc_ops_t dequeue_enc_ops; - /**< Dequeue decode function */ + /** Dequeue decode function */ rte_bbdev_dequeue_dec_ops_t dequeue_dec_ops; - /**< Enqueue encode function */ + /** Enqueue encode function */ rte_bbdev_enqueue_enc_ops_t enqueue_ldpc_enc_ops; - /**< Enqueue decode function */ + /** Enqueue decode function */ rte_bbdev_enqueue_dec_ops_t enqueue_ldpc_dec_ops; - /**< Dequeue encode function */ + /** Dequeue encode function */ rte_bbdev_dequeue_enc_ops_t dequeue_ldpc_enc_ops; - /**< Dequeue decode function */ + /** Dequeue decode function */ rte_bbdev_dequeue_dec_ops_t dequeue_ldpc_dec_ops; const struct rte_bbdev_ops *dev_ops; /**< Functions exported by PMD */ struct rte_bbdev_data *data; /**< Pointer to device data */ diff --git a/lib/librte_bbdev/rte_bbdev_op.h b/lib/librte_bbdev/rte_bbdev_op.h index 9c66721..f726d73 100644 --- a/lib/librte_bbdev/rte_bbdev_op.h +++ b/lib/librte_bbdev/rte_bbdev_op.h @@ -398,12 +398,12 @@ struct rte_bbdev_op_turbo_dec { */ uint8_t num_maps; - /**< [0 - TB : 1 - CB] */ + /** [0 - TB : 1 - CB] */ uint8_t code_block_mode; union { - /**< Struct which stores Code Block specific parameters */ + /** Struct which stores Code Block specific parameters */ struct rte_bbdev_op_dec_turbo_cb_params cb_params; - /**< Struct which stores Transport Block specific parameters */ + /** Struct which stores Transport Block specific parameters */ struct rte_bbdev_op_dec_turbo_tb_params tb_params; }; }; @@ -554,7 +554,7 @@ struct rte_bbdev_op_enc_turbo_tb_params { * the Turbo operation when r >= C-, [K:3*Kpi] */ uint16_t ncb_pos; - /**< The index of the first CB in the inbound mbuf data, default is 0 */ + /** The index of the first CB in the inbound mbuf data, default is 0 */ uint8_t r; }; @@ -751,11 +751,11 @@ enum { /** Structure specifying a single encode operation */ struct rte_bbdev_enc_op { - /**< Status of operation that was performed */ + /** Status of operation that was performed */ int status; - /**< Mempool which op instance is in */ + /** Mempool which op instance is in */ struct rte_mempool *mempool; - /**< Opaque pointer for user data */ + /** Opaque pointer for user data */ void *opaque_data; union { /** Contains turbo decoder specific parameters */ @@ -792,7 +792,7 @@ struct rte_bbdev_op_cap { } cap; /**< Operation-type specific capabilities */ }; -/**< @internal Private data structure stored with operation pool. */ +/** @internal Private data structure stored with operation pool. */ struct rte_bbdev_op_pool_private { enum rte_bbdev_op_type type; /**< Type of operations in a pool */ }; diff --git a/lib/librte_bbdev/rte_bbdev_pmd.h b/lib/librte_bbdev/rte_bbdev_pmd.h index 24ddcee..237e336 100644 --- a/lib/librte_bbdev/rte_bbdev_pmd.h +++ b/lib/librte_bbdev/rte_bbdev_pmd.h @@ -146,18 +146,18 @@ typedef int (*rte_bbdev_queue_intr_disable_t)(struct rte_bbdev *dev, * fields are for non-vital operations */ struct rte_bbdev_ops { - /**< Allocate and configure device memory. Optional. */ + /** Allocate and configure device memory. Optional. */ rte_bbdev_setup_queues_t setup_queues; - /**< Configure interrupts. Optional. */ + /** Configure interrupts. Optional. */ rte_bbdev_intr_enable_t intr_enable; - /**< Start device. Optional. */ + /** Start device. Optional. */ rte_bbdev_start_t start; - /**< Stop device. Optional. */ + /** Stop device. Optional. */ rte_bbdev_stop_t stop; - /**< Close device. Optional. */ + /** Close device. Optional. */ rte_bbdev_close_t close; - /**< Get device info. Required. */ + /** Get device info. Required. */ rte_bbdev_info_get_t info_get; /** Get device statistics. Optional. */ rte_bbdev_stats_get_t stats_get; @@ -170,7 +170,7 @@ struct rte_bbdev_ops { rte_bbdev_queue_release_t queue_release; /** Start a queue. Optional. */ rte_bbdev_queue_start_t queue_start; - /**< Stop a queue pair. Optional. */ + /** Stop a queue pair. Optional. */ rte_bbdev_queue_stop_t queue_stop; /** Enable queue interrupt. Optional */ -- 1.8.3.1