spr_pydoc_filter.py File Reference

Doxygen filter to handle custom comment formatting. More...

Data Structures
class	spr_pydoc_filter.ModuleInfo
	Represents a parsed python file. More...
class	spr_pydoc_filter.ClassInfo
	Represents a parsed class. More...
class	spr_pydoc_filter.FunctionInfo
	Represents a parsed function. More...
class	spr_pydoc_filter.ParamInfo
	Represents a function parameter. More...

Namespaces
	spr_pydoc_filter

Functions
def	spr_pydoc_filter.match_tree
	Utility function to find specific sub-trees of the parse tree. More...
def	spr_pydoc_filter.search_tree
	Utility function to find all subtrees starting with a specific node name. More...
def	spr_pydoc_filter.conv
	Utility function that converts token and symbol id numbers to readable strings. More...
def	spr_pydoc_filter.pprint_ast
	Utility function to dump a parse tree to stdout. More...
def	spr_pydoc_filter.split_comment
	Looks for an optional spr_* tag at the start of a comment. More...
def	spr_pydoc_filter.is_empty_line
def	spr_pydoc_filter.ws_len
def	spr_pydoc_filter.parse_endlist_line
def	spr_pydoc_filter.parse_itemlist_line
def	spr_pydoc_filter.convert_comment_lists
def	spr_pydoc_filter.tag_from_name
	Matches access level tags to functions based on naming convention. More...
def	spr_pydoc_filter.ast_to_tok
	Walks a parse tree and returns a list of all encountered token nodes. More...
def	spr_pydoc_filter.convert
	Convert python source code. More...
def	spr_pydoc_filter.main
	Main function. More...

Detailed Description

Doxygen filter to handle custom comment formatting.

All python scripts will be passed through this script to be transformed into a format that Doxygen can handle natively.

Author

Jan Roelens