ConForM.CoopnTools.CoKer.DocComment
Class DocGenerator

java.lang.Object
  |
  +--ConForM.CoopnTools.CoKer.DocComment.DocGenerator
Direct Known Subclasses:
ModuleDocGenerator, TocGenerator, UsedIndexGenerator

public abstract class DocGenerator
extends java.lang.Object

Generator of documentation.


Field Summary
protected  DocWriter doc
           
protected  CoopnEnv env
           
protected  java.lang.String name
           
protected  PackageMgr packageMgr
           
 
Constructor Summary
protected DocGenerator(java.lang.String name, DocWriter doc, PackageMgr packageMgr, CoopnEnv env)
          Constructor.
 
Method Summary
 void dispose()
          Terminates the generation, and dispose the resources.
abstract  void generateDocumentation()
           
protected  void writeComment(DocComment comment)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

packageMgr

protected PackageMgr packageMgr

doc

protected DocWriter doc

name

protected java.lang.String name

env

protected CoopnEnv env
Constructor Detail

DocGenerator

protected DocGenerator(java.lang.String name,
                       DocWriter doc,
                       PackageMgr packageMgr,
                       CoopnEnv env)
Constructor.
Method Detail

generateDocumentation

public abstract void generateDocumentation()

dispose

public void dispose()
Terminates the generation, and dispose the resources. This method does not close the doc Writer.

writeComment

protected void writeComment(DocComment comment)