[dpdk-dev] [PATCH] doc: update examples list for API

Ferruh Yigit ferruh.yigit at intel.com
Fri Jan 27 12:55:41 CET 2017


These files are linked to API documentation as usage samples, added
missing examples files and sorted list alphabetically.

Signed-off-by: Ferruh Yigit <ferruh.yigit at intel.com>
---
 doc/api/examples.dox | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)

diff --git a/doc/api/examples.dox b/doc/api/examples.dox
index c13e574..2d6b65b 100644
--- a/doc/api/examples.dox
+++ b/doc/api/examples.dox
@@ -12,6 +12,10 @@
 @example ethtool/ethtool-app/main.c
 @example ethtool/lib/rte_ethtool.c
 @example exception_path/main.c
+ at example flow_distributor/distributor/args.c
+ at example flow_distributor/distributor/init.c
+ at example flow_distributor/distributor/main.c
+ at example flow_distributor/node/node.c
 @example helloworld/main.c
 @example ip_fragmentation/main.c
 @example ip_pipeline/config_check.c
@@ -20,6 +24,7 @@
 @example ip_pipeline/cpu_core_map.c
 @example ip_pipeline/init.c
 @example ip_pipeline/main.c
+ at example ip_pipeline/parser.c
 @example ip_pipeline/pipeline/pipeline_common_be.c
 @example ip_pipeline/pipeline/pipeline_common_fe.c
 @example ip_pipeline/pipeline/pipeline_firewall_be.c
@@ -37,13 +42,27 @@
 @example ip_pipeline/thread.c
 @example ip_pipeline/thread_fe.c
 @example ip_reassembly/main.c
+ at example ipsec-secgw/esp.c
+ at example ipsec-secgw/ipsec.c
+ at example ipsec-secgw/ipsec-secgw.c
+ at example ipsec-secgw/parser.c
+ at example ipsec-secgw/rt.c
+ at example ipsec-secgw/sa.c
+ at example ipsec-secgw/sp4.c
+ at example ipsec-secgw/sp6.c
 @example ipv4_multicast/main.c
 @example kni/main.c
+ at example l2fwd-cat/cat.c
+ at example l2fwd-cat/l2fwd-cat.c
 @example l2fwd-crypto/main.c
 @example l2fwd-jobstats/main.c
+ at example l2fwd-keepalive/ka-agent/main.c
 @example l2fwd-keepalive/main.c
+ at example l2fwd-keepalive/shm.c
 @example l2fwd/main.c
 @example l3fwd-acl/main.c
+ at example l3fwd/l3fwd_em.c
+ at example l3fwd/l3fwd_lpm.c
 @example l3fwd/main.c
 @example l3fwd-power/main.c
 @example l3fwd-vf/main.c
@@ -52,10 +71,6 @@
 @example load_balancer/init.c
 @example load_balancer/main.c
 @example load_balancer/runtime.c
- at example flow_distributor/distributor/args.c
- at example flow_distributor/distributor/init.c
- at example flow_distributor/distributor/main.c
- at example flow_distributor/node/node.c
 @example multi_process/client_server_mp/mp_client/client.c
 @example multi_process/client_server_mp/mp_server/args.c
 @example multi_process/client_server_mp/mp_server/init.c
-- 
2.9.3



More information about the dev mailing list