[dpdk-stable] [PATCH 2/2] ethdev: clarify xstats Api documentation

[Mcnamara, John]

> -----Original Message-----
> From: stable [mailto:stable-bounces at dpdk.org] On Behalf Of Olivier Matz
> Sent: Friday, December 16, 2016 9:44 AM
> To: dev at dpdk.org; thomas.monjalon at 6wind.com
> Cc: Horton, Remy <remy.horton at intel.com>; stable at dpdk.org
> Subject: [dpdk-stable] [PATCH 2/2] ethdev: clarify xstats Api
> documentation
> 
> Reword the Api documentation of xstats ethdev.
> 
> CC: stable at dpdk.org
> Signed-off-by: Olivier Matz <olivier.matz at 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