From: Intel Date: Mon, 22 Jul 2013 22:00:00 +0000 (+0200) Subject: ethdev: fix doxygen comment for rte_eth_rx_queue_count X-Git-Tag: spdx-start~11176 X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=c25e53e079715d337d0fc9ad7f9412f08791ac01;p=dpdk.git ethdev: fix doxygen comment for rte_eth_rx_queue_count Signed-off-by: Intel --- diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h index b778326246..3509aeabc8 100644 --- a/lib/librte_ether/rte_ethdev.h +++ b/lib/librte_ether/rte_ethdev.h @@ -778,9 +778,9 @@ typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev, typedef void (*eth_queue_release_t)(void *queue); /**< @internal Release memory resources allocated by given RX/TX queue. */ -typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev, - uint16_t rx_queue_id); -/**< Get number of available descriptors on a receive queue of an Ethernet device. */ +typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev, + uint16_t rx_queue_id); +/**< @Get number of available descriptors on a receive queue of an Ethernet device. */ typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev, uint16_t vlan_id, @@ -1711,6 +1711,16 @@ rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id, } #endif +/** + * Get the number of used descriptors in a specific queue + * + * @param port_id + * The port identifier of the Ethernet device. + * @param queue_id + * The queue id on the specific port. + * @return + * The number of used descriptors in the specific queue. + */ #ifdef RTE_LIBRTE_ETHDEV_DEBUG extern uint32_t rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id); #else