From 440cde6899d2113c07d192b3490b546d8a62a5b9 Mon Sep 17 00:00:00 2001 From: Håkan Jonsson Date: Tue, 13 Sep 2016 10:44:32 +0200 Subject: doc: Initial doxygen framework for NSH SFC project MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit A first attempt for a documentation generation using Doxygen for the NSH SFC project. Doxygen tagging and documentation in the code still need to be done. Based on a copy of the Doxygen framework in VPP. Top Makefile added to (only) build documentation. Change-Id: Ibd09d9f5338609a7f57a384ded86fca874f4efdc Signed-off-by: Håkan Jonsson Signed-off-by: Ed Warnicke --- doxygen/filter_api.py | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100755 doxygen/filter_api.py (limited to 'doxygen/filter_api.py') diff --git a/doxygen/filter_api.py b/doxygen/filter_api.py new file mode 100755 index 0000000..3e2aaae --- /dev/null +++ b/doxygen/filter_api.py @@ -0,0 +1,45 @@ +#!/usr/bin/env python +# Copyright (c) 2016 Comcast Cable Communications Management, LLC. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Filter for vpe.api to make it Doxygenish. + +import sys, re + +if len(sys.argv) < 2: + sys.stderr.write("Usage: %s \n" % (sys.argv[0])) + sys.exit(1) + +patterns = [ + # Search for "define" blocks and treat them as structs + ( re.compile(r"^.*(manual_.[^\s]+\s+)?define\s+(?P[^\s]+)"), r"typedef struct vl_api_\g_t"), + + # For every "brief" statement at the start of a comment block, add an + # xref with whatever is on the same line. This gives us an index page + # with all the API methods in one place. + # XXX Commented out for now; works but duplicates the brief text in the + # struct documentation + #( re.compile(r"/\*\*\s*(?P[\\@]brief)\s+(?P.+)(\*/)$"), r'/** @xrefitem api "" "VPP API" \g \g \g'), # capture inline comment close + #( re.compile(r"/\*\*\s*(?P[\\@]brief)\s+(?P.+)$"), r'/** @xrefitem api "" "VPP API" \g \g \g'), + + # Since structs don't have params, replace @param with @tparam + ( re.compile("[\\@]param\\b"), "@tparam"), +] + +with open(sys.argv[1]) as fd: + for line in fd: + str = line[:-1] # strip \n + for p in patterns: + str = p[0].sub(p[1], str) + sys.stdout.write(str+"\n") -- cgit 1.2.3-korg