From d4024f586216a6bf4e2dfb667df8149b7f95b5c6 Mon Sep 17 00:00:00 2001 From: Chris Luke Date: Tue, 6 Sep 2016 09:32:36 -0400 Subject: 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 --- doxygen/siphon_generate.py | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) (limited to 'doxygen/siphon_generate.py') diff --git a/doxygen/siphon_generate.py b/doxygen/siphon_generate.py index 457757b510c..8b999114e52 100755 --- a/doxygen/siphon_generate.py +++ b/doxygen/siphon_generate.py @@ -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 = {} -- cgit 1.2.3-korg