summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Wallace <dwallacelf@gmail.com>2021-05-13 18:00:23 -0400
committerAndrew Yourtchenko <ayourtch@gmail.com>2021-05-21 15:33:04 +0000
commit84b543d8b1522d70aada38f3db49aade5230fc64 (patch)
treebdb6aaac1d208447458c9615f4e9eac254fd13ec
parent4ee17d859ed2f374997939511078559c26981ad0 (diff)
doxygen: fix doxygen tags
- Missing tags mess up doxygen TOC heirarchy Type: docs Signed-off-by: Dave Wallace <dwallacelf@gmail.com> Change-Id: I012d55c0ae90aecc665b56903f4212ddc0643943
-rw-r--r--doxygen/dev_doc.md3
-rw-r--r--doxygen/user_doc.md4
-rw-r--r--extras/snap/README.md3
-rw-r--r--extras/strongswan/README.md2
-rwxr-xr-xextras/vpp_stats_fs/README.md4
-rw-r--r--extras/vpptop/README.md4
6 files changed, 13 insertions, 7 deletions
diff --git a/doxygen/dev_doc.md b/doxygen/dev_doc.md
index b5306d55cd3..20e71a9a9cf 100644
--- a/doxygen/dev_doc.md
+++ b/doxygen/dev_doc.md
@@ -21,3 +21,6 @@ Programming notes for developers.
- @subpage mdata_doc
- @subpage mempreload_doc
- @subpage pnat_doc
+- @subpage snap_doc
+- @subpage srv6_ad_flow_plugin_doc
+- @subpage strongswan_test_doc
diff --git a/doxygen/user_doc.md b/doxygen/user_doc.md
index f19faefe153..ff597c0421b 100644
--- a/doxygen/user_doc.md
+++ b/doxygen/user_doc.md
@@ -15,7 +15,7 @@ Several modules provide operational, dataplane-user focused documentation.
- @subpage lb_plugin_doc
- @subpage lldp_doc
- @subpage map_doc
-- @subpage marvel_plugin_doc
+- @subpage marvell_plugin_doc
- @subpage srv6_mobile_plugin
- @subpage mtu_doc
- @subpage nat64_doc
@@ -31,3 +31,5 @@ Several modules provide operational, dataplane-user focused documentation.
- @subpage vmxnet3_doc
- @subpage af_xdp_doc
- @subpage wireguard_plugin_doc
+- @subpage vpp_top_doc
+- @subpage stats_fs_doc
diff --git a/extras/snap/README.md b/extras/snap/README.md
index 9387184533d..47fdd3c204e 100644
--- a/extras/snap/README.md
+++ b/extras/snap/README.md
@@ -1,3 +1,6 @@
+VPP Snap Build {#snap_doc}
+--------------
+
General
-------
diff --git a/extras/strongswan/README.md b/extras/strongswan/README.md
index 58cbcd96893..48d02244370 100644
--- a/extras/strongswan/README.md
+++ b/extras/strongswan/README.md
@@ -1,4 +1,4 @@
-## vpp-sswan-test
+# VPP Swanstrong Testing Recipe {#strongswan_test_doc}
Simple test framework for VPP and strongSwan scenarios.
diff --git a/extras/vpp_stats_fs/README.md b/extras/vpp_stats_fs/README.md
index 3b0b09468a6..c5ec8127d8a 100755
--- a/extras/vpp_stats_fs/README.md
+++ b/extras/vpp_stats_fs/README.md
@@ -1,4 +1,4 @@
-# VPP stats segment FUSE filesystem
+# VPP stats segment FUSE filesystem {#stats_fs_doc}
The statfs binary allows to create a FUSE filesystem to expose and to browse the stats segment.
Is is leaned on the Go-FUSE library and requires Go-VPP stats bindings to work.
@@ -58,4 +58,4 @@ sudo fusermount -u /path/to/mountpoint
To force the unmount even if the resource is busy, add the -z option:
```bash
sudo fusermount -uz /path/to/mountpoint
-``` \ No newline at end of file
+```
diff --git a/extras/vpptop/README.md b/extras/vpptop/README.md
index 215f7df29b2..c0f4dc99b3a 100644
--- a/extras/vpptop/README.md
+++ b/extras/vpptop/README.md
@@ -1,4 +1,4 @@
-## VPPTop installer
+# VPP Top Installation {#vpp_top_doc}
[VPPTop]((https://github.com/PANTHEONtech/vpptop)) is a real-time data viewer for VPP interfaces and metrics displayed in dynamic terminal user interface, written in GO.
@@ -23,5 +23,3 @@ GOROOT=/root/.go/
GOPATH=/root/go/
If you have the GO already installed and have to run the installer with `sudo`, use the `-E` switch to provide those variables to the installer.
-
-