example: improve example application documentations

Include short description in Doxygen output for each example application.
The documentations are moved to application source files for ease of
maintenance.

Signed-off-by: Matias Elo <matias.elo@nokia.com>
Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com>

3 files changed, 2 insertions, 102 deletions

diff --git a/doc/application-api-guide/Doxyfile b/doc/application-api-guide/Doxyfile
index 7f8c70c8e..13a365c72 100644
--- a/doc/application-api-guide/Doxyfile
+++ b/doc/application-api-guide/Doxyfile
@@ -5,6 +5,7 @@ PROJECT_NUMBER = $(ODP_VERSION_API)
 PROJECT_LOGO = $(SRCDIR)/doc/images/ODP-Logo-HQ.svg
 INPUT = $(SRCDIR)/doc/application-api-guide \
 	include \
-	$(SRCDIR)/include
+	$(SRCDIR)/include \
+	$(SRCDIR)/example
 EXAMPLE_PATH = $(SRCDIR)/example $(SRCDIR)/CONTRIBUTING $(SRCDIR)/include/README
 WARNINGS = NO
diff --git a/doc/application-api-guide/Makefile.am b/doc/application-api-guide/Makefile.am
index 7d9003976..29599597d 100644
--- a/doc/application-api-guide/Makefile.am
+++ b/doc/application-api-guide/Makefile.am
@@ -1,7 +1,6 @@
 EXTRA_DIST = \
 	     Doxyfile \
 	     api_guide_lines.dox \
-	     examples.dox \
 	     odp.dox \
 	     release.dox
 
diff --git a/doc/application-api-guide/examples.dox b/doc/application-api-guide/examples.dox
deleted file mode 100644
index 18817cd63..000000000
--- a/doc/application-api-guide/examples.dox
+++ /dev/null
@@ -1,100 +0,0 @@
-/* Copyright (c) 2015-2019, Linaro Limited
- * All rights reserved.
- *
- * SPDX-License-Identifier: BSD-3-Clause
- */
-
-/**
- * @example odp_classifier.c
- * Classifier example application
- */
-
-/**
- * @example odp_cli.c
- * CLI example application
- */
-
-/**
- * @example odp_debug.c
- * Debug example application
- */
-
-/**
- * @example odp_generator.c
- * Traffic generator and loopback demo application
- */
-
-/**
- * @example odp_hello.c
- * Minimal example application
- */
-
-/**
- * @example odp_ipfragreass.c
- * IPv4 lock-free fragmentation and reassembly example application
- */
-
-/**
- * @example ipsec_api/odp_ipsec.c
- * IPsec example application using IPsec API
- */
-
- /**
- * @example ipsec_crypto/odp_ipsec.c
- * IPsec example application using crypto API
- */
-
-/**
- * @example odp_l2fwd.c
- * L2 forwarding example application
- */
-
-/**
- * @example odp_l2fwd_simple.c
- * Minimal L2 forwarding example application
- */
-
-/**
- * @example odp_l3fwd.c
- * L3 forwarding example application
- */
-
-/**
- *@example odp_ping.c
- * Example application which replies to ICMPv4 echo requests (ping)
- */
-
-/**
- *@example odp_pktio.c
- * Basic packet IO loopback test application
- */
-
- /**
- *@example odp_simple_pipeline.c
- * Simple pipeline example application
- */
-
-/**
- * @example odp_switch.c
- * Minimal learning Ethernet switch example application
- */
-
- /**
- * @example odp_sysinfo.c
- * System information example application
- */
-
-/**
- * @example time_global_test.c
- * Time example application
- */
-
-/**
- * @example odp_timer_test.c
- * Timer example application
- */
-
- /**
- * @example odp_traffic_mgmt.c
- * Traffic manager example application
- */