summaryrefslogtreecommitdiffstats
path: root/doxygen
diff options
context:
space:
mode:
authorPablo Camarillo <pcamaril@cisco.com>2017-03-16 10:43:05 +0100
committerDamjan Marion <dmarion.lists@gmail.com>2017-03-29 08:56:05 +0000
commit4521afa9a643983c789b6b3a77b14c0a95d5e0b2 (patch)
tree0902086700854c4b6f5597b2cd0bb6f47be77a62 /doxygen
parent45ce3fbee5c1a7ad2a01f766c9b05059aa467b8f (diff)
Bugfixing and documentation for SRv6
- Fixed three coverity issues - Linked SRv6 docs - Moved sample plugin to examples folder - Fixed bug with hash. Now everything is using mhash. Potentially in the future we want to do bihash. Change-Id: Ie03a13c8fecb1e315e67d0596cbd23220779aaf2 Signed-off-by: Pablo Camarillo <pcamaril@cisco.com>
Diffstat (limited to 'doxygen')
-rw-r--r--doxygen/Makefile6
-rw-r--r--doxygen/user_doc.md13
2 files changed, 10 insertions, 9 deletions
diff --git a/doxygen/Makefile b/doxygen/Makefile
index 973ca07facc..9caa4079980 100644
--- a/doxygen/Makefile
+++ b/doxygen/Makefile
@@ -53,7 +53,8 @@ DOXY_SRC_DIRECTORIES = \
$(DOXY_SRC)/vlibsocket \
$(DOXY_SRC)/vnet \
$(DOXY_SRC)/vpp \
- $(DOXY_SRC)/vpp-api
+ $(DOXY_SRC)/vpp-api \
+ $(DOXY_SRC)/examples
# Input directories and files
DOXY_INPUT ?= \
@@ -72,9 +73,8 @@ DOXY_INPUT := $(subst $(WS_ROOT)/,,$(DOXY_INPUT))
# These must be left-anchored paths for the regexp below to work.
DOXY_EXCLUDE ?= \
$(DOXY_SRC)/vlib/vlib/buffer.c \
- $(DOXY_SRC)/vlib/example \
$(DOXY_SRC)/vpp-api/lua \
- plugins/sample-plugin
+ $(DOXY_SRC)/examples/sample-plugin
# 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 40303439a81..29df6156cd9 100644
--- a/doxygen/user_doc.md
+++ b/doxygen/user_doc.md
@@ -4,13 +4,14 @@ User Documentation {#user_doc}
Several modules provide operational, dataplane-user focused documentation.
- [GUI guided user demo](https://wiki.fd.io/view/VPP_Sandbox/vpp-userdemo)
-- @subpage qos_doc
-- @subpage ipsec_gre_doc
-- @subpage dpdk_crypto_ipsec_doc
-- @subpage map_doc
-- @subpage lldp_doc
+- @subpage bfd_doc
- @subpage ioam_plugin_doc
+- @subpage ipsec_gre_doc
- @subpage lb_plugin_doc
+- @subpage lldp_doc
+- @subpage map_doc
+- @subpage dpdk_crypto_ipsec_doc
- @subpage flowperpkt_plugin_doc
+- @subpage qos_doc
- @subpage span_doc
-- @subpage bfd_doc
+- @subpage srv6_doc