[dpdk-dev] doc: add PMD specific API
Checks
Commit Message
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
doc/api/doxy-api-index.md | 4 ++++
doc/api/doxy-api.conf | 2 ++
2 files changed, 6 insertions(+)
Comments
2017-01-27 12:27, Ferruh Yigit:
> --- a/doc/api/doxy-api-index.md
> +++ b/doc/api/doxy-api-index.md
> @@ -153,3 +153,7 @@ There are many libraries, so their headers may be grouped by topics:
> [ABI compat] (@ref rte_compat.h),
> [keepalive] (@ref rte_keepalive.h),
> [version] (@ref rte_version.h)
> +
> +- **PMD specific**:
> + [ixgbe] (@ref rte_pmd_ixgbe.h),
> + [i40e] (@ref rte_pmd_i40e.h)
They could be grouped with bonding, vhost and KNI
in a section device-specific, below "device" section.
@@ -153,3 +153,7 @@ There are many libraries, so their headers may be grouped by topics:
[ABI compat] (@ref rte_compat.h),
[keepalive] (@ref rte_keepalive.h),
[version] (@ref rte_version.h)
+
+- **PMD specific**:
+ [ixgbe] (@ref rte_pmd_ixgbe.h),
+ [i40e] (@ref rte_pmd_i40e.h)
@@ -32,6 +32,8 @@ PROJECT_NAME = DPDK
INPUT = doc/api/doxy-api-index.md \
doc/api/examples.dox \
drivers/net/bonding \
+ drivers/net/i40e \
+ drivers/net/ixgbe \
lib/librte_eal/common/include \
lib/librte_eal/common/include/generic \
lib/librte_acl \