Re: [dpdk-dev] [PATCH] vhost: add doxygen comment to vDPA header

[Ye Xiaolong <xiaolong.ye@intel.com>]

On 10/11, Ferruh Yigit wrote:
>On 10/10/2018 10:14 AM, Xiaolong Ye wrote:
>> As APIs in rte_vdpa.h are public, we need to add doxygen comments
>> to all APIs and structures.
>> 
>> Signed-off-by: Xiaolong Ye <xiaolong.ye@intel.com>
>
><...>
>
>> @@ -29,6 +32,9 @@ struct rte_vdpa_dev_addr {
>>  	};
>>  };
>>  
>> +/**
>> + * vdpa device operations
>> + */
>>  struct rte_vdpa_dev_ops {
>>  	/* Get capabilities of this device */
>>  	int (*get_queue_num)(int did, uint32_t *queue_num);
>
>Can you please document all fields of the structs?
>This is part of public API and needs to be documented properly, if possible more
>detail on struct documentation will be good.
>

Got it, I'll add more descriptions.

><...>
>
>> -/* Register a vdpa device, return did if successful, -1 on failure */
>> +/**
>> + * Register a vdpa device
>> + *
>> + * @param addr
>> + *  the vdpa device address
>> + * @parm ops
>> + *  the vdpa device operations
>> + * @return
>> + *  device id on success, -1 on failure
>> + */
>>  int __rte_experimental
>>  rte_vdpa_register_device(struct rte_vdpa_dev_addr *addr,
>>  		struct rte_vdpa_dev_ops *ops);
>
>For experimental APIs we tend to add following into function comment:
>  * @warning
>  * @b EXPERIMENTAL: this API may change without prior notice
>
>Please check lib/librte_member/rte_member.h for samples.

Got it.

Thanks,
Xiaolong