[dpdk-dev] [PATCH 2/2] doc: add API documentation for bnxt PMD

Ferruh Yigit ferruh.yigit at intel.com
Mon Sep 11 18:36:21 CEST 2017


On 9/11/2017 5:33 PM, Ferruh Yigit wrote:
> Signed-off-by: Ferruh Yigit <ferruh.yigit at intel.com>
> ---
>  doc/api/doxy-api-index.md | 1 +
>  doc/api/doxy-api.conf     | 1 +
>  2 files changed, 2 insertions(+)
> 
> diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
> index 19e0d4f3d..1e8068d7c 100644
> --- a/doc/api/doxy-api-index.md
> +++ b/doc/api/doxy-api-index.md
> @@ -55,6 +55,7 @@ The public API headers are grouped by topics:
>    [KNI]                (@ref rte_kni.h),
>    [ixgbe]              (@ref rte_pmd_ixgbe.h),
>    [i40e]               (@ref rte_pmd_i40e.h),
> +  [bnxt]               (@ref rte_pmd_bnxt.h),

Hi Stephen, Ajit,

Can you please update header file with doxygen comments? Since it is
public header file now, APIs should be documented properly.

Thanks,
ferruh

>    [crypto_scheduler]   (@ref rte_cryptodev_scheduler.h)

<...>


More information about the dev mailing list