Re: [dpdk-dev] [PATCH v8 1/2] vhost: introduce API to get vDPA device number

[Ferruh Yigit <ferruh.yigit@intel.com>]

On 9/28/2018 10:47 PM, Xiaolong Ye wrote:
> It's used to get number of available registered vDPA devices.
> 
> Signed-off-by: Xiaolong Ye <xiaolong.ye@intel.com>
> Acked-by: Xiao Wang <xiao.w.wang@intel.com>
> Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>
> ---
>  lib/librte_vhost/rte_vdpa.h            | 3 +++
>  lib/librte_vhost/rte_vhost_version.map | 1 +
>  lib/librte_vhost/vdpa.c                | 6 ++++++
>  3 files changed, 10 insertions(+)
> 
> diff --git a/lib/librte_vhost/rte_vdpa.h b/lib/librte_vhost/rte_vdpa.h
> index 90465ca26..b8223e337 100644
> --- a/lib/librte_vhost/rte_vdpa.h
> +++ b/lib/librte_vhost/rte_vdpa.h
> @@ -84,4 +84,7 @@ rte_vdpa_find_device_id(struct rte_vdpa_dev_addr *addr);
>  struct rte_vdpa_device * __rte_experimental
>  rte_vdpa_get_device(int did);
>  
> +/* Get current available vdpa device number */
> +int __rte_experimental
> +rte_vdpa_get_device_num(void);

Hi Xiaolong,

Is rte_vdpa_get_device_num() an public API? (It should be since it will be used
in an application in next patch.)

If so, header needs to be part of API documentation:
1- Update doc/api/doxy-api-index.md to include this header.
2- Update all APIs comments to be an doxygen comment.
3- Add doxygen comment to all data structures.

I can see rte_vdpa.h not documented at all, it is not just this API, so it can
be better to send a new patch to address above items.

Thanks,
ferruh