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>
This commit is contained in:
Dave Wallace
2019-04-17 17:28:45 -04:00
parent 0d7332e43f
commit 11ee93f6ab
10 changed files with 312 additions and 7 deletions

File diff suppressed because it is too large Load Diff

View File

@ -12,3 +12,6 @@ Programming notes for developers.
- @subpage acl_lookup_context
- @subpage libmemif_doc
- @subpage syslog_doc
- @subpage ipfix_doc
- @subpage stats_doc
- @subpage if_stats_client_doc

View File

@ -7,6 +7,7 @@ Several modules provide operational, dataplane-user focused documentation.
- @subpage avf_plugin_doc
- @subpage bfd_doc
- @subpage dpdk_crypto_ipsec_doc
- @subpage dhcp6_pd_doc
- @subpage flowprobe_plugin_doc
- @subpage ioam_plugin_doc
- @subpage ipsec_gre_doc
@ -16,10 +17,13 @@ Several modules provide operational, dataplane-user focused documentation.
- @subpage lldp_doc
- @subpage map_doc
- @subpage marvel_plugin_doc
- @subpage mtu_doc
- @subpage nat64_doc
- @subpage nat_ha_doc
- @subpage qos_doc
- @subpage selinux_doc
- @subpage span_doc
- @subpage srmpls_doc
- @subpage srv6_doc
- @subpage vcl_ldpreload_doc
- @subpage vmxnet3_doc

View File

@ -2,7 +2,7 @@
import os, fnmatch, subprocess
starttag = 'v19.01-rc0'
endtag = 'v19.01'
endtag = 'HEAD'
emit_md = True
apifiles = []

View File

@ -1,4 +1,4 @@
# VPP interface stats client
# VPP interface stats client {#if_stats_client_doc}
This is a source code and a binary of a 'thin client' to collect,
aggregate and expose VPP interface stats through VPP stats socket API.

View File

@ -1,4 +1,4 @@
# Active-Passive NAT HA
# Active-Passive NAT HA {#nat_ha_doc}
## Introduction

View File

@ -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.

View File

@ -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

View File

@ -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

View File

@ -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.