xml2dox Namespace Reference

Functions
def	parameterDocumentationHeader ()
def	parameterDocumentationFooter ()
def	parameterEnhancedNumber (pname, pinfo, pval)
def	parameterIntegerRangeList (pname, pinfo, pval)
def	parameterFileName (pname, pinfo, pval)
def	parameterAnyNumber (pname, pinfo, pval)
def	parameterStringToIntegral (pname, pinfo, pval)
def	parameterString (pname, pinfo, pval)
def	writeInfo (param)

Variables
	outfile = open("parameters.dox", "w")
	tree = ET.parse("../data/parameters.xml")
	Begin. More...
	root = tree.getroot()
list	validators = []
dictionary	vals = {}
	id = node.get("validatorId")
list	parameterInfo = []
	Create list of a 3-tuples for each parameter, including the parameter name, its data, and its validator. More...
	paramName = node.get("name")

Function Documentation

parameterDocumentationHeader()

def xml2dox.parameterDocumentationHeader

(

)

Definition at line 13 of file xml2dox.py.

parameterDocumentationFooter()

def xml2dox.parameterDocumentationFooter

(

)

Definition at line 19 of file xml2dox.py.

parameterEnhancedNumber()

def xml2dox.parameterEnhancedNumber	(		pname,
			pinfo,
			pval
	)

Definition at line 22 of file xml2dox.py.

parameterIntegerRangeList()

def xml2dox.parameterIntegerRangeList	(		pname,
			pinfo,
			pval
	)

Definition at line 37 of file xml2dox.py.

parameterFileName()

def xml2dox.parameterFileName	(		pname,
			pinfo,
			pval
	)

Definition at line 67 of file xml2dox.py.

parameterAnyNumber()

def xml2dox.parameterAnyNumber	(		pname,
			pinfo,
			pval
	)

Definition at line 74 of file xml2dox.py.

parameterStringToIntegral()

def xml2dox.parameterStringToIntegral	(		pname,
			pinfo,
			pval
	)

Definition at line 92 of file xml2dox.py.

parameterString()

def xml2dox.parameterString	(		pname,
			pinfo,
			pval
	)

Definition at line 122 of file xml2dox.py.

writeInfo()

def xml2dox.writeInfo

(

param

)

Definition at line 133 of file xml2dox.py.

Variable Documentation

outfile

xml2dox.outfile = open("parameters.dox", "w")

Definition at line 11 of file xml2dox.py.

tree

xml2dox.tree = ET.parse("../data/parameters.xml")

Begin.

Definition at line 166 of file xml2dox.py.

root

xml2dox.root = tree.getroot()

Definition at line 168 of file xml2dox.py.

validators

xml2dox.validators = []

Definition at line 174 of file xml2dox.py.

vals

dictionary xml2dox.vals = {}

Definition at line 186 of file xml2dox.py.

id

xml2dox.id = node.get("validatorId")

Definition at line 189 of file xml2dox.py.

parameterInfo

list xml2dox.parameterInfo = []

Create list of a 3-tuples for each parameter, including the parameter name, its data, and its validator.

Definition at line 197 of file xml2dox.py.

paramName

xml2dox.paramName = node.get("name")

Definition at line 207 of file xml2dox.py.