summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorDave Wallace <dwallacelf@gmail.com>2019-04-17 17:28:45 -0400
committerFlorin Coras <florin.coras@gmail.com>2019-04-19 20:38:22 +0000
commit51cbbd2282f39ff1b64781c73efbbe3b332ed3d9 (patch)
tree10bb0c7d1ed9f5511d42de18198e9acb877bc01b /src
parent9e6c53bbd685f9fefa295d12dfe6bc55b5e5d3ea (diff)
Doxygen cleanup.
- Add subpages definitions in appropriate section (User or Dev docs) for doc files (*.rst, *.md) that being listed at the top level of the generated doc page. - Generate and add API list to RELEASE doc. - Fix list_api_changes script to use HEAD as the endtag so it doesn't need to be changed every release. Change-Id: Iace7b6433359c6b96869cb1db01facbbcb0ac1e6 Signed-off-by: Dave Wallace <dwallacelf@gmail.com> (cherry picked from commit 11ee93f6abfaddf5bbd56cf0858c0c6ea0384b65)
Diffstat (limited to 'src')
-rw-r--r--src/plugins/nat/nat_ha_doc.md2
-rw-r--r--src/plugins/vmxnet3/README.md2
-rw-r--r--src/vnet/MTU.md2
-rw-r--r--src/vnet/ipfix-export/ipfix_doc.md2
-rw-r--r--src/vpp/stats/stats.md2
5 files changed, 5 insertions, 5 deletions
diff --git a/src/plugins/nat/nat_ha_doc.md b/src/plugins/nat/nat_ha_doc.md
index 82f7f283bf0..2d504231d9b 100644
--- a/src/plugins/nat/nat_ha_doc.md
+++ b/src/plugins/nat/nat_ha_doc.md
@@ -1,4 +1,4 @@
-# Active-Passive NAT HA
+# Active-Passive NAT HA {#nat_ha_doc}
## Introduction
diff --git a/src/plugins/vmxnet3/README.md b/src/plugins/vmxnet3/README.md
index 722954d51a3..6e9fb194c94 100644
--- a/src/plugins/vmxnet3/README.md
+++ b/src/plugins/vmxnet3/README.md
@@ -1,4 +1,4 @@
-# VMWARE vmxnet3 device driver plugin
+# VMWARE vmxnet3 device driver plugin {#vmxnet3_doc}
##Overview
This plugin provides native PCI driver support for VMWare vmxnet3.
diff --git a/src/vnet/MTU.md b/src/vnet/MTU.md
index 32b8c39edea..a0a8ba87490 100644
--- a/src/vnet/MTU.md
+++ b/src/vnet/MTU.md
@@ -1,4 +1,4 @@
-# Introduction
+# MTU Introduction {#mtu_doc}
Maximum Transmission Unit is a term used to describe the maximum sized "thingy" that can be sent out an interface. It can refer to the maximum frame size that a NIC can send. On Ethernet that would include the Ethernet header but typically not the IGF. It can refer to the maximum packet size, that is, on Ethernet an MTU of 1500, would allow an IPv4 packet of 1500 bytes, that would result in an Ethernet frame of 1518 bytes.
# MTU in VPP
diff --git a/src/vnet/ipfix-export/ipfix_doc.md b/src/vnet/ipfix-export/ipfix_doc.md
index 5feea0e19fa..59118f68e11 100644
--- a/src/vnet/ipfix-export/ipfix_doc.md
+++ b/src/vnet/ipfix-export/ipfix_doc.md
@@ -1,4 +1,4 @@
-# IPFIX support {#ipfix}
+# IPFIX support {#ipfix_doc}
VPP includes a high-performance IPFIX record exporter. This note
explains how to use the internal APIs to export IPFIX data, and how to
diff --git a/src/vpp/stats/stats.md b/src/vpp/stats/stats.md
index dd14a188e47..521ab916876 100644
--- a/src/vpp/stats/stats.md
+++ b/src/vpp/stats/stats.md
@@ -1,4 +1,4 @@
-# Statistics
+# Statistics {#stats_doc}
In VPP most things are measured and counted. There are counters for interface statistics, like RX, TX counters, packet drops, and so on. Every node has a set of per-node counters, one set of error counters, like TTL exceeded, or packet to big or out-of-buffers. And a set of performance counters, like number of clocks, vectors, calls and suspends.