|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.biomage.tools.generate_doc.CreateDocFile
public class CreateDocFile
Constructor Summary | |
---|---|
CreateDocFile(java.util.Vector classFiles,
java.lang.String docFileName,
java.lang.String outputDir)
Description: Constructor for the Doc file generator. |
Method Summary | |
---|---|
void |
writeAttrs(java.io.FileWriter writer,
java.util.Vector attrs,
java.lang.String type)
Description: Constructor for the Doc file generator. |
void |
writeFileDocs(java.io.FileWriter writer,
CreateFile createFile)
Description: Work horse method that takes a CreateFile and writes out the documentation for it. |
void |
writeHeader(java.io.FileWriter writer,
CreateClassFile.DataTypeAttrInformation attr)
Description: Simple method to distinguish between true attribute from the other subclasses. |
void |
writeHeader(java.io.FileWriter writer,
CreateFile.AssociationAttrInformation attr)
Description: Simple method to distinguish between true attribute from the other subclasses. |
void |
writeMethods(java.io.FileWriter writer,
java.util.Vector methods)
Description: Constructor for the Doc file generator. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CreateDocFile(java.util.Vector classFiles, java.lang.String docFileName, java.lang.String outputDir) throws java.lang.Exception
classFiles:
- information on the classes to obtain the documentation.docFileName:
- what to name the output file.outputDir:
- where to write the file.
java.lang.Exception
Method Detail |
---|
public void writeFileDocs(java.io.FileWriter writer, CreateFile createFile) throws java.lang.Exception
writer:
- used to write the comments to the file.createFile:
- represents the class whose comments are to be written.
java.lang.Exception
public void writeMethods(java.io.FileWriter writer, java.util.Vector methods) throws java.lang.Exception
writer:
- used to write the comments to the file.methods:
- the methods to write out the documentation.
java.lang.Exception
public void writeAttrs(java.io.FileWriter writer, java.util.Vector attrs, java.lang.String type) throws java.lang.Exception
writer:
- used to write the comments to the file.attrs:
- the attributes (or subclass) to write out the documentation.type:
- the type of attribute (Attribute, Association, or Operations)
java.lang.Exception
public void writeHeader(java.io.FileWriter writer, CreateClassFile.DataTypeAttrInformation attr) throws java.lang.Exception
writer:
- used to write the comments to the file.attr:
- the attribute to write out the header information.
java.lang.Exception
public void writeHeader(java.io.FileWriter writer, CreateFile.AssociationAttrInformation attr) throws java.lang.Exception
writer:
- used to write the comments to the file.attr:
- the attribute to write out the header information.
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |