Zoltan2 Version of the Day
Functions | Variables
xml2dox Namespace Reference

Functions

def parameterDocumentationHeader
def parameterDocumentationFooter
def parameterEnhancedNumber
def parameterIntegerRangeList
def parameterFileName
def parameterAnyNumber
def parameterStringToIntegral
def parameterString
def writeInfo

Variables

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

Function Documentation

def xml2dox::parameterDocumentationHeader ( )

Definition at line 13 of file xml2dox.py.

def xml2dox::parameterDocumentationFooter ( )

Definition at line 19 of file xml2dox.py.

def xml2dox::parameterEnhancedNumber (   pname,
  pinfo,
  pval 
)

Definition at line 22 of file xml2dox.py.

def xml2dox::parameterIntegerRangeList (   pname,
  pinfo,
  pval 
)

Definition at line 37 of file xml2dox.py.

def xml2dox::parameterFileName (   pname,
  pinfo,
  pval 
)

Definition at line 67 of file xml2dox.py.

def xml2dox::parameterAnyNumber (   pname,
  pinfo,
  pval 
)

Definition at line 74 of file xml2dox.py.

def xml2dox::parameterStringToIntegral (   pname,
  pinfo,
  pval 
)

Definition at line 92 of file xml2dox.py.

def xml2dox::parameterString (   pname,
  pinfo,
  pval 
)

Definition at line 122 of file xml2dox.py.

def xml2dox::writeInfo (   param)

Definition at line 133 of file xml2dox.py.


Variable Documentation

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

Definition at line 11 of file xml2dox.py.

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

Begin.

Definition at line 166 of file xml2dox.py.

tuple xml2dox::root = tree.getroot()

Definition at line 168 of file xml2dox.py.

Definition at line 174 of file xml2dox.py.

dictionary xml2dox::vals = {}

Definition at line 186 of file xml2dox.py.

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

Definition at line 189 of file xml2dox.py.

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.

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

Definition at line 207 of file xml2dox.py.