[dpdk-dev] [PATCH] doc: add doxygen documentation for ipsec library
Vladimir Medvedkin
vladimir.medvedkin at intel.com
Thu Oct 10 18:52:14 CEST 2019
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 at intel.com>
---
doc/api/doxy-api-index.md | 6 ++++++
doc/api/doxy-api.conf.in | 1 +
2 files changed, 7 insertions(+)
diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 6c2d888..d19ffdf 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -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),
diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
index 908cee8..d8dafb2 100644
--- a/doc/api/doxy-api.conf.in
+++ b/doc/api/doxy-api.conf.in
@@ -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 \
--
2.7.4
More information about the dev
mailing list