From 84b543d8b1522d70aada38f3db49aade5230fc64 Mon Sep 17 00:00:00 2001 From: Dave Wallace Date: Thu, 13 May 2021 18:00:23 -0400 Subject: doxygen: fix doxygen tags - Missing tags mess up doxygen TOC heirarchy Type: docs Signed-off-by: Dave Wallace Change-Id: I012d55c0ae90aecc665b56903f4212ddc0643943 --- extras/snap/README.md | 3 +++ extras/strongswan/README.md | 2 +- extras/vpp_stats_fs/README.md | 4 ++-- extras/vpptop/README.md | 4 +--- 4 files changed, 7 insertions(+), 6 deletions(-) (limited to 'extras') 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. - - -- cgit 1.2.3-korg