summaryrefslogtreecommitdiffstats
path: root/doxygen
diff options
context:
space:
mode:
authorRay Kinsella <ray.kinsella@intel.com>2017-06-08 15:54:19 +0100
committerChris Luke <chris_luke@comcast.com>2017-06-09 16:34:40 +0000
commit583dc8d3e23a780c85ebe48ea59f0338aad4df17 (patch)
treec52c9ef7a020b0cce27917bc5e3a6a09f4423639 /doxygen
parent7d5fae861ed243983155ade90c81fc27a47bf376 (diff)
Sample plugin: Add sample plugin documentation
Added some user documentation to sample plugin. Change-Id: I518910f80499307e8fcac8dcef7baaeab5ea8e35 Signed-off-by: Ray Kinsella <ray.kinsella@intel.com>
Diffstat (limited to 'doxygen')
-rw-r--r--doxygen/Makefile3
-rw-r--r--doxygen/user_doc.md1
2 files changed, 2 insertions, 2 deletions
diff --git a/doxygen/Makefile b/doxygen/Makefile
index abaca185d74..b6ba5887666 100644
--- a/doxygen/Makefile
+++ b/doxygen/Makefile
@@ -74,8 +74,7 @@ DOXY_INPUT := $(subst $(WS_ROOT)/,,$(DOXY_INPUT))
# These must be left-anchored paths for the regexp below to work.
DOXY_EXCLUDE ?= \
$(DOXY_SRC)/vlib/buffer.c \
- $(DOXY_SRC)/vpp-api/lua \
- $(DOXY_SRC)/examples/sample-plugin
+ $(DOXY_SRC)/vpp-api/lua
# Generate a regexp for filenames to exclude
DOXY_EXCLUDE_REGEXP = ($(subst .,\.,$(shell echo '$(strip $(DOXY_EXCLUDE))' | sed -e 's/ /|/g')))
diff --git a/doxygen/user_doc.md b/doxygen/user_doc.md
index becc2e0a353..c0a05bd96f0 100644
--- a/doxygen/user_doc.md
+++ b/doxygen/user_doc.md
@@ -16,3 +16,4 @@ Several modules provide operational, dataplane-user focused documentation.
- @subpage span_doc
- @subpage srv6_doc
- @subpage srmpls_doc
+- @subpage sample_plugin_doc