[dpdk-dev,2/2] doc: add API documentation for bnxt PMD
Checks
Commit Message
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
doc/api/doxy-api-index.md | 1 +
doc/api/doxy-api.conf | 1 +
2 files changed, 2 insertions(+)
Comments
On 9/11/2017 5:33 PM, Ferruh Yigit wrote:
> Signed-off-by: Ferruh Yigit <ferruh.yigit@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)
<...>
> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Monday, September 11, 2017 5:34 PM
> To: Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org; Yigit, Ferruh <ferruh.yigit@intel.com>; Stephen Hurd
> <stephen.hurd@broadcom.com>; Ajit Khaparde <ajit.khaparde@broadcom.com>;
> Wu, Jingjing <jingjing.wu@intel.com>; Zhang, Helin
> <helin.zhang@intel.com>; Zhang, Helin <helin.zhang@intel.com>; Ananyev,
> Konstantin <konstantin.ananyev@intel.com>
> Subject: [PATCH 2/2] doc: add API documentation for bnxt PMD
>
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
@@ -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),
[crypto_scheduler] (@ref rte_cryptodev_scheduler.h)
- **memory**:
@@ -34,6 +34,7 @@ INPUT = doc/api/doxy-api-index.md \
drivers/net/bonding \
drivers/net/i40e \
drivers/net/ixgbe \
+ drivers/net/bnxt \
lib/librte_eal/common/include \
lib/librte_eal/common/include/generic \
lib/librte_acl \