summaryrefslogtreecommitdiffstats
path: root/doc/api/generate_examples.sh
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/generate_examples.sh')
-rwxr-xr-xdoc/api/generate_examples.sh12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/api/generate_examples.sh b/doc/api/generate_examples.sh
new file mode 100755
index 00000000..6fcfe513
--- /dev/null
+++ b/doc/api/generate_examples.sh
@@ -0,0 +1,12 @@
+#! /bin/sh -e
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright 2018 Luca Boccassi <bluca@debian.org>
+
+EXAMPLES_DIR=$1
+API_EXAMPLES=$2
+
+exec > "${API_EXAMPLES}"
+printf '/**\n'
+printf '@page examples DPDK Example Programs\n\n'
+find "${EXAMPLES_DIR}" -type f -name '*.c' -printf '@example examples/%P\n' | LC_ALL=C sort
+printf '*/\n'