> -----Original Message-----
> From: stable [mailto:stable-boun...@dpdk.org] On Behalf Of Olivier Matz
> Sent: Friday, December 16, 2016 9:44 AM
> To: dev@dpdk.org; thomas.monja...@6wind.com
> Cc: Horton, Remy <remy.hor...@intel.com>; sta...@dpdk.org
> Subject: [dpdk-stable] [PATCH 2/2] ethdev: clarify xstats Api
> documentation
>
> Reword the Api documentation of xstats ethdev.
>
> CC: sta...@dpdk.org
> Signed-off-by: Olivier Matz <olivier.m...@6wind.com>
> ---
> lib/librte_ether/rte_ethdev.h | 45 ++++++++++++++++++++++++--------------
> -----
> ...
> int rte_eth_xstats_get_names(uint8_t port_id,
> struct rte_eth_xstat_name *xstats_names, @@ -2296,19 +2300,20
> @@ int rte_eth_xstats_get_names(uint8_t port_id,
> * The port identifier of the Ethernet device.
> * @param xstats
> * A pointer to a table of structure of type *rte_eth_xstat*
> - * to be filled with device statistics ids and values.
> + * to be filled with device statistics ids and values: id is the
> + * index of the name string in xstats_names (@see
> rte_eth_xstats_get_names),
The @see directive starts a new "See also" section and breaks/interrupts the
parameter description. Probably what you want is:
index of the name string in xstats_names (see rte_eth_xstats_get_names()),
Otherwise it is a good update.
John
