doc: add doxygen documentation for ipsec library
Checks
Commit Message
Added ipsec API from:
- rte_ipsec.h
- rte_ipsec_sa.h
- rte_ipsec_group.h
- rte_ipsec_sad.h
Signed-off-by: Vladimir Medvedkin <vladimir.medvedkin@intel.com>
---
doc/api/doxy-api-index.md | 6 ++++++
doc/api/doxy-api.conf.in | 1 +
2 files changed, 7 insertions(+)
Comments
> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Vladimir Medvedkin
> Sent: Thursday, October 10, 2019 10:22 PM
> To: dev@dpdk.org
> Cc: konstantin.ananyev@intel.com; john.mcnamara@intel.com;
> marko.kovacevic@intel.com
> Subject: [dpdk-dev] [PATCH] doc: add doxygen documentation for ipsec library
>
> Added ipsec API from:
> - rte_ipsec.h
> - rte_ipsec_sa.h
> - rte_ipsec_group.h
> - rte_ipsec_sad.h
>
> Signed-off-by: Vladimir Medvedkin <vladimir.medvedkin@intel.com>
> ---
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
Applied to dpdk-next-crypto
Thanks.
22/10/2019 10:05, Akhil Goyal:
>
> > -----Original Message-----
> > From: dev <dev-bounces@dpdk.org> On Behalf Of Vladimir Medvedkin
> > Sent: Thursday, October 10, 2019 10:22 PM
> > To: dev@dpdk.org
> > Cc: konstantin.ananyev@intel.com; john.mcnamara@intel.com;
> > marko.kovacevic@intel.com
> > Subject: [dpdk-dev] [PATCH] doc: add doxygen documentation for ipsec library
> >
> > Added ipsec API from:
> > - rte_ipsec.h
> > - rte_ipsec_sa.h
> > - rte_ipsec_group.h
> > - rte_ipsec_sad.h
> >
> > Signed-off-by: Vladimir Medvedkin <vladimir.medvedkin@intel.com>
> > ---
> Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
>
> Applied to dpdk-next-crypto
I am moving the index entries in the "layers" section with other protocols,
while pulling this.
@@ -132,6 +132,12 @@ The public API headers are grouped by topics:
[tailq] (@ref rte_tailq.h),
[bitmap] (@ref rte_bitmap.h)
+- **ipsec**:
+ [ipsec] (@ref rte_ipsec.h),
+ [ipsec_sa] (@ref rte_ipsec_sa.h),
+ [ipsec_group] (@ref rte_ipsec_group.h),
+ [ipsec_sad] (@ref rte_ipsec_sad.h)
+
- **packet framework**:
* [port] (@ref rte_port.h):
[ethdev] (@ref rte_port_ethdev.h),
@@ -35,6 +35,7 @@ INPUT = @TOPDIR@/doc/api/doxy-api-index.md \
@TOPDIR@/lib/librte_gso \
@TOPDIR@/lib/librte_hash \
@TOPDIR@/lib/librte_ip_frag \
+ @TOPDIR@/lib/librte_ipsec \
@TOPDIR@/lib/librte_jobstats \
@TOPDIR@/lib/librte_kni \
@TOPDIR@/lib/librte_kvargs \