Functions
def	categorize_xml (tree)

def	find_all_elements (tree, name, tag)

def	find_first_element_with_tag (tree, tag)

def	find_method_element_text (method, name)

def	generate_xml (input_path, output_path, quiet=False)

def	init_doc (file_path)

def	parse (input_path, output_path, quiet=False, generate_xml_flag=True)

Variables
string	DOXYGEN_CONF = 'doxygen.conf'

Function Documentation

◆ categorize_xml()

def parse_xml.categorize_xml ( tree )

Determine the type of the object the xml tree represents.

Arguments:
tree -- an xml tree or path to xml string

Definition at line 63 of file parse_xml.py.

◆ find_all_elements()

def parse_xml.find_all_elements	(	tree,
		name,
		tag
	)

Definition at line 107 of file parse_xml.py.

◆ find_first_element_with_tag()

def parse_xml.find_first_element_with_tag	(	tree,
		tag
	)

Definition at line 100 of file parse_xml.py.

◆ find_method_element_text()

def parse_xml.find_method_element_text	(	method,
		name
	)

Definition at line 111 of file parse_xml.py.

◆ generate_xml()

def parse_xml.generate_xml	(	input_path,
		output_path,
		quiet = `False`
	)

Parse the file for documentation and output it as in an xml format

Definition at line 41 of file parse_xml.py.

◆ init_doc()

def parse_xml.init_doc ( file_path )

Initialize documentation given its type.

Categorize the xml tree at file_path and initiliaze the corresponding doc
type with the xml tree and other relevant information.

Arguments:
file_path -- path to the xml tree

Returns:
    An initialized Doc

Definition at line 80 of file parse_xml.py.

◆ parse()

def parse_xml.parse	(	input_path,
		output_path,
		quiet = `False`,
		generate_xml_flag = `True`
	)

Parse the files for documentation and store it in templates.

Arguments:
input_path -- path to the input folder or file
output_path -- path to the output folder
quiet -- turn on/off the messages that are generated to standard output by
         Doxygen (default = False)
generate_xml -- use Doxygen to generate xml (default = True)

Returns:
    A Docs template storing all the documentation in the input.

Definition at line 10 of file parse_xml.py.

Variable Documentation

◆ DOXYGEN_CONF

string parse_xml.DOXYGEN_CONF = 'doxygen.conf'

Definition at line 7 of file parse_xml.py.

Functions

Variables