diff options
author | Pablo Camarillo <pcamaril@cisco.com> | 2017-03-16 10:43:05 +0100 |
---|---|---|
committer | Neale Ranns <nranns@cisco.com> | 2017-03-29 14:01:49 +0000 |
commit | f60b77c159c794c5a847b76d77a12c584a85bfbd (patch) | |
tree | 7431840fb1d2138ae2f60d7ab89e831def4c99e8 /doxygen | |
parent | ff077a040194eb3dd80214738d741bc757f4f210 (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/Makefile | 6 | ||||
-rw-r--r-- | doxygen/user_doc.md | 13 |
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 |