[dpdk-dev] [PATCH v7 6/6] Link Bonding Library doxygen additions
Thomas Monjalon
thomas.monjalon at 6wind.com
Wed Jun 25 15:43:32 CEST 2014
Hi Declan,
Since bonding library is a PMD, there should have no need of integrate it
in the API documentation.
I hadn't time to review it yet, so I would miss something.
Do you mean it can be used directly by the application with a specific API?
In this case, you could explain it in the commit log.
2014-06-24 17:03, Declan Doherty:
> --- a/doc/doxy-api-index.md
> +++ b/doc/doxy-api-index.md
> @@ -36,6 +36,7 @@ API {#index}
> There are many libraries, so their headers may be grouped by topics:
>
> - **device**:
> + [bond] (@ref rte_eth_bond.h),
> [ethdev] (@ref rte_ethdev.h),
> [devargs] (@ref rte_devargs.h),
> [KNI] (@ref rte_kni.h),
ethdev should be first in this list.
> --- a/doc/doxy-api.conf
> +++ b/doc/doxy-api.conf
> @@ -30,6 +30,7 @@
>
> PROJECT_NAME = DPDK
> INPUT = doc/doxy-api-index.md \
> + lib/librte_pmd_bond \
> lib/librte_eal/common/include \
> lib/librte_acl \
> lib/librte_distributor \
Libraries should be in alphabetical order here.
Thanks
--
Thomas
More information about the dev
mailing list