From d281632b36b6a681feed8e923ca3105bdbe583dd Mon Sep 17 00:00:00 2001 From: Thomas Monjalon Date: Sat, 18 Jul 2015 20:04:13 +0200 Subject: [PATCH] ethdev: fix doxygen internal comments The internal functions must be marked with the doxygen command @internal. The allocate and release_port functions are not restricted only to dummy drivers. Signed-off-by: Thomas Monjalon --- lib/librte_ether/rte_ethdev.h | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h index 8f1cf8d84a..8b04edc31f 100644 --- a/lib/librte_ether/rte_ethdev.h +++ b/lib/librte_ether/rte_ethdev.h @@ -1646,8 +1646,9 @@ extern struct rte_eth_dev rte_eth_devices[]; extern uint8_t rte_eth_dev_count(void); /** - * Function for internal use by port hotplug functions. + * @internal * Returns a ethdev slot specified by the unique identifier name. + * * @param name * The pointer to the Unique identifier name for each Ethernet device * @return @@ -1656,8 +1657,7 @@ extern uint8_t rte_eth_dev_count(void); extern struct rte_eth_dev *rte_eth_dev_allocated(const char *name); /** - * Function for internal use by dummy drivers primarily, e.g. ring-based - * driver. + * @internal * Allocates a new ethdev slot for an ethernet device and returns the pointer * to that slot for the driver to use. * @@ -1670,8 +1670,7 @@ struct rte_eth_dev *rte_eth_dev_allocate(const char *name, enum rte_eth_dev_type type); /** - * Function for internal use by dummy drivers primarily, e.g. ring-based - * driver. + * @internal * Release the specified ethdev port. * * @param eth_dev -- 2.20.1