d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

ethdev: fix doxygen internal comments

Browse Source 
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 <thomas.monjalon@6wind.com>
This commit is contained in:
Thomas Monjalon 2015-07-18 20:04:13 +02:00
parent ff3ae4d446
commit d281632b36
1 changed files with 4 additions and 5 deletions

9
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); 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. * Returns a ethdev slot specified by the unique identifier name.
*
* @param name * @param name
* The pointer to the Unique identifier name for each Ethernet device * The pointer to the Unique identifier name for each Ethernet device
* @return * @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); extern struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
/** /**
* Function for internal use by dummy drivers primarily, e.g. ring-based * @internal
* driver.
* Allocates a new ethdev slot for an ethernet device and returns the pointer * Allocates a new ethdev slot for an ethernet device and returns the pointer
* to that slot for the driver to use. * 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); enum rte_eth_dev_type type);
/** /**
* Function for internal use by dummy drivers primarily, e.g. ring-based * @internal
* driver.
* Release the specified ethdev port. * Release the specified ethdev port.
* *
* @param eth_dev * @param eth_dev