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>

45 files changed, 202 insertions, 12 deletions

diff --git a/example/classifier/odp_classifier.c b/example/classifier/odp_classifier.c
index 4f71c835b..da92085b0 100644
--- a/example/classifier/odp_classifier.c
+++ b/example/classifier/odp_classifier.c
@@ -6,6 +6,14 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/**
+ * @example odp_classifier.c
+ *
+ * Classifier API example application
+ *
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
+ */
+
 #include <stdlib.h>
 #include <string.h>
 #include <getopt.h>
diff --git a/example/cli/odp_cli.c b/example/cli/odp_cli.c
index 5f87b2a78..55b70c8bb 100644
--- a/example/cli/odp_cli.c
+++ b/example/cli/odp_cli.c
@@ -4,12 +4,14 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
-/*
- * ODP CLI Helper Example
+/**
+ * @example odp_cli.c
  *
  * This example shows how to start and stop ODP CLI using the CLI helper
  * API functions. This example application can also be used to try out
  * the CLI by connecting to a running application with a telnet client.
+ *
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
  */
 
 #include <odp_api.h>
diff --git a/example/debug/odp_debug.c b/example/debug/odp_debug.c
index a2f322e09..c7cf8b90b 100644
--- a/example/debug/odp_debug.c
+++ b/example/debug/odp_debug.c
@@ -4,6 +4,14 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/**
+ * @example odp_debug.c
+ *
+ * This example application demonstrates the usage of various debug print functions of ODP API.
+ *
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
+ */
+
 #include <stdlib.h>
 #include <stdio.h>
 #include <stdint.h>
diff --git a/example/generator/odp_generator.c b/example/generator/odp_generator.c
index 95ba04c1e..e62e46701 100644
--- a/example/generator/odp_generator.c
+++ b/example/generator/odp_generator.c
@@ -4,6 +4,14 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/**
+ * @example odp_generator.c
+ *
+ * Traffic generator and loopback demo application
+ *
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
+ */
+
 /** enable strtok */
 #ifndef _GNU_SOURCE
 #define _GNU_SOURCE
diff --git a/example/hello/odp_hello.c b/example/hello/odp_hello.c
index 391406946..3516864b8 100644
--- a/example/hello/odp_hello.c
+++ b/example/hello/odp_hello.c
@@ -4,10 +4,15 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
-/* This is a minimal application which demonstrates the startup and shutdown
+/**
+ * @example odp_hello.c
+ *
+ * This is a minimal application which demonstrates the startup and shutdown
  * steps of an ODP application. It can be also used to debug API related
  * build problems, etc. It does not use helpers to minimize dependency to
  * anything else than the ODP API header file.
+ *
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
  */
 
 #include <stdio.h>
diff --git a/example/ipfragreass/odp_ipfragreass.c b/example/ipfragreass/odp_ipfragreass.c
index 55c76d7cc..db2da70ce 100644
--- a/example/ipfragreass/odp_ipfragreass.c
+++ b/example/ipfragreass/odp_ipfragreass.c
@@ -5,9 +5,11 @@
  */
 
 /**
- * @file
+ * @example odp_ipfragreass.c
  *
- * @example odp_ipfragreass.c  ODP IPv4 lock-free fragmentation and reassembly
+ * IPv4 lock-free fragmentation and reassembly example application
+ *
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
  */
 
 #include <stdio.h>
diff --git a/example/ipfragreass/odp_ipfragreass_fragment.c b/example/ipfragreass/odp_ipfragreass_fragment.c
index 2cce75e91..85e9180d6 100644
--- a/example/ipfragreass/odp_ipfragreass_fragment.c
+++ b/example/ipfragreass/odp_ipfragreass_fragment.c
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #include <stdio.h>
 #include <assert.h>
 
diff --git a/example/ipfragreass/odp_ipfragreass_fragment.h b/example/ipfragreass/odp_ipfragreass_fragment.h
index e0e8cfea7..f6be87bf3 100644
--- a/example/ipfragreass/odp_ipfragreass_fragment.h
+++ b/example/ipfragreass/odp_ipfragreass_fragment.h
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #ifndef ODP_FRAGREASS_PP_FRAG_H_
 #define ODP_FRAGREASS_PP_FRAG_H_
 
diff --git a/example/ipfragreass/odp_ipfragreass_helpers.c b/example/ipfragreass/odp_ipfragreass_helpers.c
index ac737fe44..a99b6aaa7 100644
--- a/example/ipfragreass/odp_ipfragreass_helpers.c
+++ b/example/ipfragreass/odp_ipfragreass_helpers.c
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:	 BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #include <stdio.h>
 #include <stdlib.h>
 
diff --git a/example/ipfragreass/odp_ipfragreass_helpers.h b/example/ipfragreass/odp_ipfragreass_helpers.h
index af47e326c..e115b3d7f 100644
--- a/example/ipfragreass/odp_ipfragreass_helpers.h
+++ b/example/ipfragreass/odp_ipfragreass_helpers.h
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #ifndef ODP_FRAGREASS_PP_HELPERS_H_
 #define ODP_FRAGREASS_PP_HELPERS_H_
 
diff --git a/example/ipfragreass/odp_ipfragreass_ip.h b/example/ipfragreass/odp_ipfragreass_ip.h
index 9c8f2a5f7..d9b64e8c9 100644
--- a/example/ipfragreass/odp_ipfragreass_ip.h
+++ b/example/ipfragreass/odp_ipfragreass_ip.h
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:	 BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #ifndef ODP_FRAGREASS_PP_IP_H_
 #define ODP_FRAGREASS_PP_IP_H_
 
diff --git a/example/ipfragreass/odp_ipfragreass_reassemble.c b/example/ipfragreass/odp_ipfragreass_reassemble.c
index 2542a3b97..d6799c82c 100644
--- a/example/ipfragreass/odp_ipfragreass_reassemble.c
+++ b/example/ipfragreass/odp_ipfragreass_reassemble.c
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:	 BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #include <odp_api.h>
 
 #include <stdio.h>
diff --git a/example/ipfragreass/odp_ipfragreass_reassemble.h b/example/ipfragreass/odp_ipfragreass_reassemble.h
index 1fb71284e..d0ccc2ddb 100644
--- a/example/ipfragreass/odp_ipfragreass_reassemble.h
+++ b/example/ipfragreass/odp_ipfragreass_reassemble.h
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:	 BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #ifndef ODP_FRAGREASS_PP_REASSEMBLE_H_
 #define ODP_FRAGREASS_PP_REASSEMBLE_H_
 
diff --git a/example/ipsec_api/odp_ipsec.c b/example/ipsec_api/odp_ipsec.c
index 524b1ae76..3ac561d90 100644
--- a/example/ipsec_api/odp_ipsec.c
+++ b/example/ipsec_api/odp_ipsec.c
@@ -5,9 +5,11 @@
  */
 
 /**
- * @file
+ * @example ipsec_api/odp_ipsec.c
  *
- * @example odp_example_ipsec.c  ODP basic packet IO cross connect with IPsec test application
+ * IPsec example application using ODP IPsec API
+ *
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
  */
 
 /* enable strtok */
diff --git a/example/ipsec_api/odp_ipsec_cache.c b/example/ipsec_api/odp_ipsec_cache.c
index c16c71115..d81257569 100644
--- a/example/ipsec_api/odp_ipsec_cache.c
+++ b/example/ipsec_api/odp_ipsec_cache.c
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #include <stdlib.h>
 #include <string.h>
 
diff --git a/example/ipsec_api/odp_ipsec_cache.h b/example/ipsec_api/odp_ipsec_cache.h
index b0e1fa3f0..2ae29347d 100644
--- a/example/ipsec_api/odp_ipsec_cache.h
+++ b/example/ipsec_api/odp_ipsec_cache.h
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #ifndef ODP_IPSEC_CACHE_H_
 #define ODP_IPSEC_CACHE_H_
 
diff --git a/example/ipsec_crypto/odp_ipsec.c b/example/ipsec_crypto/odp_ipsec.c
index 06d52c311..765a96bbe 100644
--- a/example/ipsec_crypto/odp_ipsec.c
+++ b/example/ipsec_crypto/odp_ipsec.c
@@ -6,9 +6,11 @@
  */
 
 /**
- * @file
+ * @example ipsec_crypto/odp_ipsec.c
  *
- * @example odp_example_ipsec.c  ODP basic packet IO cross connect with IPsec test application
+ * IPsec example application using ODP crypto API
+ *
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
  */
 
 /* enable strtok */
diff --git a/example/ipsec_crypto/odp_ipsec_cache.c b/example/ipsec_crypto/odp_ipsec_cache.c
index 65a51bd1d..b916ce952 100644
--- a/example/ipsec_crypto/odp_ipsec_cache.c
+++ b/example/ipsec_crypto/odp_ipsec_cache.c
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #include <stdlib.h>
 #include <string.h>
 
diff --git a/example/ipsec_crypto/odp_ipsec_cache.h b/example/ipsec_crypto/odp_ipsec_cache.h
index b1e3e7ac1..e506071e2 100644
--- a/example/ipsec_crypto/odp_ipsec_cache.h
+++ b/example/ipsec_crypto/odp_ipsec_cache.h
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #ifndef ODP_IPSEC_CACHE_H_
 #define ODP_IPSEC_CACHE_H_
 
diff --git a/example/ipsec_crypto/odp_ipsec_fwd_db.c b/example/ipsec_crypto/odp_ipsec_fwd_db.c
index 9bd399ca9..71074a46c 100644
--- a/example/ipsec_crypto/odp_ipsec_fwd_db.c
+++ b/example/ipsec_crypto/odp_ipsec_fwd_db.c
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 /* enable strtok */
 #ifndef _GNU_SOURCE
 #define _GNU_SOURCE
diff --git a/example/ipsec_crypto/odp_ipsec_fwd_db.h b/example/ipsec_crypto/odp_ipsec_fwd_db.h
index c6d9c6c99..dc9c66f84 100644
--- a/example/ipsec_crypto/odp_ipsec_fwd_db.h
+++ b/example/ipsec_crypto/odp_ipsec_fwd_db.h
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #ifndef ODP_IPSEC_FWD_DB_H_
 #define ODP_IPSEC_FWD_DB_H_
 
diff --git a/example/ipsec_crypto/odp_ipsec_misc.h b/example/ipsec_crypto/odp_ipsec_misc.h
index 69788d115..de9f1ee32 100644
--- a/example/ipsec_crypto/odp_ipsec_misc.h
+++ b/example/ipsec_crypto/odp_ipsec_misc.h
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #ifndef ODP_IPSEC_MISC_H_
 #define ODP_IPSEC_MISC_H_
 
diff --git a/example/ipsec_crypto/odp_ipsec_sa_db.c b/example/ipsec_crypto/odp_ipsec_sa_db.c
index 9d3418681..92921cc98 100644
--- a/example/ipsec_crypto/odp_ipsec_sa_db.c
+++ b/example/ipsec_crypto/odp_ipsec_sa_db.c
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:	BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 /* enable strtok */
 #ifndef _GNU_SOURCE
 #define _GNU_SOURCE
diff --git a/example/ipsec_crypto/odp_ipsec_sa_db.h b/example/ipsec_crypto/odp_ipsec_sa_db.h
index 72231369f..9e5489b26 100644
--- a/example/ipsec_crypto/odp_ipsec_sa_db.h
+++ b/example/ipsec_crypto/odp_ipsec_sa_db.h
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #ifndef ODP_IPSEC_SA_DB_H_
 #define ODP_IPSEC_SA_DB_H_
 
diff --git a/example/ipsec_crypto/odp_ipsec_sp_db.c b/example/ipsec_crypto/odp_ipsec_sp_db.c
index 3ead3b0a3..af0404478 100644
--- a/example/ipsec_crypto/odp_ipsec_sp_db.c
+++ b/example/ipsec_crypto/odp_ipsec_sp_db.c
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 /* enable strtok */
 #ifndef _GNU_SOURCE
 #define _GNU_SOURCE
diff --git a/example/ipsec_crypto/odp_ipsec_sp_db.h b/example/ipsec_crypto/odp_ipsec_sp_db.h
index b71ea9377..e0d3ebfdb 100644
--- a/example/ipsec_crypto/odp_ipsec_sp_db.h
+++ b/example/ipsec_crypto/odp_ipsec_sp_db.h
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #ifndef ODP_IPSEC_SP_DB_H_
 #define ODP_IPSEC_SP_DB_H_
 
diff --git a/example/ipsec_crypto/odp_ipsec_stream.c b/example/ipsec_crypto/odp_ipsec_stream.c
index f8bc64eae..1d3419431 100644
--- a/example/ipsec_crypto/odp_ipsec_stream.c
+++ b/example/ipsec_crypto/odp_ipsec_stream.c
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 /* enable strtok */
 #ifndef _GNU_SOURCE
 #define _GNU_SOURCE
diff --git a/example/ipsec_crypto/odp_ipsec_stream.h b/example/ipsec_crypto/odp_ipsec_stream.h
index 2055d3f00..f0cb4f1dd 100644
--- a/example/ipsec_crypto/odp_ipsec_stream.h
+++ b/example/ipsec_crypto/odp_ipsec_stream.h
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #ifndef ODP_IPSEC_STREAM_H_
 #define ODP_IPSEC_STREAM_H_
 
diff --git a/example/l2fwd_simple/odp_l2fwd_simple.c b/example/l2fwd_simple/odp_l2fwd_simple.c
index c9ae94c12..d7dad1787 100644
--- a/example/l2fwd_simple/odp_l2fwd_simple.c
+++ b/example/l2fwd_simple/odp_l2fwd_simple.c
@@ -4,6 +4,14 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/**
+ * @example odp_l2fwd_simple.c
+ *
+ * Minimal L2 forwarding example application
+ *
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
+ */
+
 #include <stdlib.h>
 #include <stdio.h>
 #include <getopt.h>
diff --git a/example/l3fwd/odp_l3fwd.c b/example/l3fwd/odp_l3fwd.c
index 7d6b15af0..6952ed650 100644
--- a/example/l3fwd/odp_l3fwd.c
+++ b/example/l3fwd/odp_l3fwd.c
@@ -4,6 +4,14 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/**
+ * @example odp_l3fwd.c
+ *
+ * L3 forwarding example application
+ *
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
+ */
+
 #include <stdlib.h>
 #include <stdio.h>
 #include <errno.h>
diff --git a/example/l3fwd/odp_l3fwd_db.c b/example/l3fwd/odp_l3fwd_db.c
index a4e4681f6..2c68d4700 100644
--- a/example/l3fwd/odp_l3fwd_db.c
+++ b/example/l3fwd/odp_l3fwd_db.c
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #ifndef _GNU_SOURCE
 #define _GNU_SOURCE
 #endif
diff --git a/example/l3fwd/odp_l3fwd_db.h b/example/l3fwd/odp_l3fwd_db.h
index b26c67e44..cf8691a2b 100644
--- a/example/l3fwd/odp_l3fwd_db.h
+++ b/example/l3fwd/odp_l3fwd_db.h
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #ifndef _ODP_L3FWD_DB_H_
 #define _ODP_L3FWD_DB_H_
 
diff --git a/example/l3fwd/odp_l3fwd_lpm.c b/example/l3fwd/odp_l3fwd_lpm.c
index 7eb32b5d0..de0b79c6a 100644
--- a/example/l3fwd/odp_l3fwd_lpm.c
+++ b/example/l3fwd/odp_l3fwd_lpm.c
@@ -3,6 +3,9 @@
  *
  * SPDX-License-Identifier:     BSD-3-Clause
  */
+
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #ifndef _GNU_SOURCE
 #define _GNU_SOURCE
 #endif
diff --git a/example/l3fwd/odp_l3fwd_lpm.h b/example/l3fwd/odp_l3fwd_lpm.h
index 4f2b9ad7f..a3bbf2811 100644
--- a/example/l3fwd/odp_l3fwd_lpm.h
+++ b/example/l3fwd/odp_l3fwd_lpm.h
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
 #ifndef _ODP_L3FWD_LPM_H_
 #define _ODP_L3FWD_LPM_H_
 
diff --git a/example/packet/odp_packet_dump.c b/example/packet/odp_packet_dump.c
index 6d00c237e..d08e73cd7 100644
--- a/example/packet/odp_packet_dump.c
+++ b/example/packet/odp_packet_dump.c
@@ -4,6 +4,14 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/**
+ * @example odp_packet_dump.c
+ *
+ * Packet dump example application which prints received packets to terminal
+ *
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
+ */
+
 #include <stdio.h>
 #include <string.h>
 #include <signal.h>
diff --git a/example/packet/odp_pktio.c b/example/packet/odp_pktio.c
index 191d9fdb6..43037327b 100644
--- a/example/packet/odp_pktio.c
+++ b/example/packet/odp_pktio.c
@@ -4,6 +4,14 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/**
+ * @example odp_pktio.c
+ *
+ * Basic packet IO loopback example application
+ *
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
+ */
+
 #include <stdlib.h>
 #include <string.h>
 #include <getopt.h>
diff --git a/example/ping/odp_ping.c b/example/ping/odp_ping.c
index dbe453319..97b856895 100644
--- a/example/ping/odp_ping.c
+++ b/example/ping/odp_ping.c
@@ -2,6 +2,16 @@
  * Copyright (c) 2019-2023 Nokia
  */
 
+/**
+ * @example odp_ping.c
+ *
+ * This application replies to IPv4 ping requests. It can be used to test
+ * connectivity with standard ping utility. ARP table needs to be setup manually
+ * on the sender side as the application does not reply to ARP requests.
+ *
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
+ */
+
 #include <stdio.h>
 #include <string.h>
 #include <signal.h>
diff --git a/example/simple_pipeline/odp_simple_pipeline.c b/example/simple_pipeline/odp_simple_pipeline.c
index b8fb2d0be..177b8bd22 100644
--- a/example/simple_pipeline/odp_simple_pipeline.c
+++ b/example/simple_pipeline/odp_simple_pipeline.c
@@ -4,6 +4,17 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+ /**
+  * @example odp_simple_pipeline.c
+  *
+  * Simple pipeline example application which receives packets from one
+  * interface and passes them through 0-N worker stages before outputting them
+  * from a second network interface. The RX, worker, and TX stages are connected
+  * using plain queues and each stage is run on a separate CPU thread.
+  *
+  * @cond _ODP_HIDE_FROM_DOXYGEN_
+  */
+
 #include <stdlib.h>
 #include <stdio.h>
 #include <getopt.h>
diff --git a/example/switch/odp_switch.c b/example/switch/odp_switch.c
index b40f5c07c..476cbbae1 100644
--- a/example/switch/odp_switch.c
+++ b/example/switch/odp_switch.c
@@ -5,6 +5,14 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/**
+ * @example odp_switch.c
+ *
+ * Minimal learning Ethernet switch example application
+ *
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
+ */
+
 #include <stdio.h>
 #include <getopt.h>
 #include <unistd.h>
diff --git a/example/sysinfo/odp_sysinfo.c b/example/sysinfo/odp_sysinfo.c
index 151388263..d8a0141c8 100644
--- a/example/sysinfo/odp_sysinfo.c
+++ b/example/sysinfo/odp_sysinfo.c
@@ -5,6 +5,15 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+ /**
+  * @example odp_sysinfo.c
+  *
+  * Example application which queries and prints out various system information
+  * and capabilities which are available through ODP APIs.
+  *
+  * @cond _ODP_HIDE_FROM_DOXYGEN_
+  */
+
 #ifndef _GNU_SOURCE
 #define _GNU_SOURCE
 #endif
diff --git a/example/time/time_global_test.c b/example/time/time_global_test.c
index 2357f25d6..c1d11e5a4 100644
--- a/example/time/time_global_test.c
+++ b/example/time/time_global_test.c
@@ -4,6 +4,14 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/**
+ * @example time_global_test.c
+ *
+ * Time API test application
+ *
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
+ */
+
 #include <inttypes.h>
 
 #include <odp_api.h>
diff --git a/example/timer/odp_timer_accuracy.c b/example/timer/odp_timer_accuracy.c
index 23c40e66f..fba01be28 100644
--- a/example/timer/odp_timer_accuracy.c
+++ b/example/timer/odp_timer_accuracy.c
@@ -5,6 +5,14 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/**
+ * @example odp_timer_accuracy.c
+ *
+ * ODP timer accuracy test application
+ *
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
+ */
+
 #include <errno.h>
 #include <stdio.h>
 #include <string.h>
diff --git a/example/timer/odp_timer_simple.c b/example/timer/odp_timer_simple.c
index 681f95714..6521313a2 100644
--- a/example/timer/odp_timer_simple.c
+++ b/example/timer/odp_timer_simple.c
@@ -3,11 +3,13 @@
  *
  * SPDX-License-Identifier:     BSD-3-Clause
  */
+
 /**
- * @file
+ * @example odp_timer_simple.c
+ *
+ * Minimal example application demonstrating ODP timer API usage
  *
- * @example odp_timer_simple.c  ODP simple example to schedule timer
- *				action for 1 second.
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
  */
 
 #include <string.h>
diff --git a/example/timer/odp_timer_test.c b/example/timer/odp_timer_test.c
index 0be53c4cd..e6ebfdcb4 100644
--- a/example/timer/odp_timer_test.c
+++ b/example/timer/odp_timer_test.c
@@ -4,6 +4,14 @@
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/**
+ * @example odp_timer_test.c
+ *
+ * Timer test application
+ *
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
+ */
+
 #include <string.h>
 #include <stdlib.h>
 #include <inttypes.h>
diff --git a/example/traffic_mgmt/odp_traffic_mgmt.c b/example/traffic_mgmt/odp_traffic_mgmt.c
index 5c97c5433..2178b5e2f 100644
--- a/example/traffic_mgmt/odp_traffic_mgmt.c
+++ b/example/traffic_mgmt/odp_traffic_mgmt.c
@@ -7,6 +7,14 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
+ /**
+  * @example odp_traffic_mgmt.c
+  *
+  * Traffic manager API example application
+  *
+  * @cond _ODP_HIDE_FROM_DOXYGEN_
+  */
+
 #ifndef _GNU_SOURCE
 #define _GNU_SOURCE
 #endif