VPP-346 More VPP doc fixes

- Fix issue in Doxy dependency check when nothing needs to be installed.
  'set -e' and plain '[]' logic don't mix well.
- Fix Makefile snafu when building Doxy output for a single file.
- Include only one of vnet/vnet/buffer.c/dpdk_buffer.c in docs depending on
  DPDKness. This could do with some improvement in future, eg to properly
  align the pre-doxy steps with what Doxy does.
- Fix rendering of 'inline' tag in Doxygen by having it interpret
  always_inline as "inline static".
- Bunch of duplicate CLI command structure names that confused docs and may
  one day have caused debugging issues.
- Several other Doxygen syntax issues fixed, like documenting non-existant
  parameters (usually just the wrong parameter name, typos, etc)

Change-Id: Ia8cca545e5de9f8750602bffa3c4548acc8971aa
Signed-off-by: Chris Luke <chrisy@flirble.org>
This commit is contained in:
Chris Luke
2016-09-06 09:32:36 -04:00
committed by Damjan Marion
parent 7394b5b06b
commit d4024f5862
19 changed files with 99 additions and 47 deletions

View File

@ -80,6 +80,21 @@ def count_braces(str, count=0, found=False):
# Collated output for each siphon
output = {}
# Build a list of known siphons
known_siphons = []
for item in siphon_patterns:
siphon = item[1]
if siphon not in known_siphons:
known_siphons.append(siphon)
# Setup information for siphons we know about
for siphon in known_siphons:
output[siphon] = {
"file": "%s/%s.siphon" % (args.output, siphon),
"global": {},
"items": [],
}
# Pre-process file names in case they indicate a file with
# a list of files
files = []
@ -233,12 +248,6 @@ for filename in files:
if close_siphon is not None:
# Write the siphoned contents to the right place
siphon_name = close_siphon[0]
if siphon_name not in output:
output[siphon_name] = {
"global": {},
"items": [],
"file": "%s/%s.siphon" % (args.output, close_siphon[0])
}
# Copy directives for the file
details = {}