doxyfilter-perl.py File Reference

Doxygen filter for Perl modules. More...

Go to the source code of this file.

Namespaces
namespace	doxyfilter-perl
Variables
tuple	doxyfilter-perl::argtype = m.group('type')
tuple	doxyfilter-perl::comment = m.group('comment')
string	doxyfilter-perl::currentBlock = ''
tuple	doxyfilter-perl::f = open(fileName, 'r')
list	doxyfilter-perl::fileName = sys.argv[1]
tuple	doxyfilter-perl::inout = m.group('inout')
tuple	doxyfilter-perl::line = line.strip()
tuple	doxyfilter-perl::m = reCommentLine.match(line)
tuple	doxyfilter-perl::module = m.group('module')
tuple	doxyfilter-perl::name = m.group('name')
tuple	doxyfilter-perl::param = m.group('param')
list	doxyfilter-perl::params = []
string	doxyfilter-perl::previousBlock = ''
tuple	doxyfilter-perl::reCommentLine = re.compile(r"#+(?P<comment>.*)$")
tuple	doxyfilter-perl::reCommentStart = re.compile(r"##+(?P<comment>.*)$")
tuple	doxyfilter-perl::reConstant = re.compile(r"use\s+constant\s+(?P<name>\w+)(\s+.*|;)?$")
tuple	doxyfilter-perl::reFunctionEnd = re.compile(r"}$")
tuple	doxyfilter-perl::reFunctionStart = re.compile(r"sub\s*(?P<name1>\w+)\s*{?$")
tuple	doxyfilter-perl::reInclude = re.compile(r"use\s+(?P<module>[a-zA-Z:]+)(\s+.*|;)?$")
tuple	doxyfilter-perl::reParamDoc = re.compile(r"[\@\\]param\s*(\[\s*(?P<inout>in|out|in\s*,\s*out|out\s*,\s*in)\s*\]|\s*)\s+(?P<type>[$%@]\$?)?(?P<param>\w+)")
tuple	doxyfilter-perl::reShaBang = re.compile(r"#!\s*/usr/bin/env\s+perl$|#!\s*/usr/bin/perl$")

---

Detailed Description

Doxygen filter for Perl modules.

Copyright (c) 2012 University of Pennsylvania. All rights reserved.
See https://www.cbica.upenn.edu/sbia/software/license.html or COPYING file.

Contact: SBIA Group <sbia-software at uphs.upenn.edu>

Definition in file doxyfilter-perl.py.