Formatter which produces dia files.
Parameters
- filenamePrefix
- A prefix to preprend to the base names of
files and directories being created. This
is useful for situations where the names
which would be automatically generated might
cause a name clash or conflict.
- dateStampFiles
- Boolean indicating whether or not to include
a date/time stamp in files.
- debug
- Enable debugging comments in output.
|
Base Classes
|
|
happydoclib.formatter.fileformatterbase.FileBasedFormatter
|
|
Methods
|
|
|
|
|
|
BeginObjectSection
|
BeginObjectSection ( self, output )
Write the beginning of the object section in the dia file.
|
|
|
EndObjectSection
|
EndObjectSection ( self, output )
Write the end of the object section in the dia file.
|
|
|
NewLine
|
NewLine ( self )
|
|
|
WriteObject
|
WriteObject (
self,
objectName,
methods,
output,
)
Writes an object to the dia file.
Parameters: objectName: Name of the class (string)
methods: list containing the information about the methods.
Each entry in the list is a tuple consisting of
(methodName, methodType, methodParameters)
|
|
|
_ComputeSize
|
_ComputeSize (
self,
objectName,
methods,
)
Return a tuple consisting of the width and the height of
an object.
|
|
|
__init__
|
__init__ (
self,
docSet,
docsetTitle=None,
dateStampFiles=1,
debug=0,
**configuration,
)
Initialize the DiaFormatter.
Parameters
-
docSet
- the DocSet instance containing global cross-reference
information
-
**configuration
- additional, optional, configuration values
|
|
|
_writeMethods
|
_writeMethods (
self,
methods,
output,
)
Writes the methods of a class.
Parameter: methods: list containing the information about the methods.
Each entry in the list is a tuple consisting of
(methodName, methodType, methodParameters)
|
|
|
closeOutput
|
closeOutput ( self, output )
Close the output handle.
|
|
|
fileFooter
|
fileFooter ( self, output )
Write the formatting for a file footer to the open file.
|
|
|
fileHeader
|
fileHeader (
self,
title1,
title2=' ',
output=None,
)
Write the formatting for a file header to the open file.
|
|
|
getRootNodeName
|
getRootNodeName ( self )
Returns the name of the root node for documentation of this type.
|
|
|
openOutput
|
openOutput (
self,
name,
title1,
title2=' ',
)
Open output destination using name with the title from title1.
|
|
|
writeGeneralization
|
writeGeneralization (
self,
class_name,
base_class,
output,
)
Write a generalization relation between class_name and
base_class.
|
|