ConForM.CoopnTools.CoKer.DocComment
Class UsedIndexGenerator

java.lang.Object
  |
  +--ConForM.CoopnTools.CoKer.DocComment.DocGenerator
        |
        +--ConForM.CoopnTools.CoKer.DocComment.UsedIndexGenerator

public class UsedIndexGenerator
extends DocGenerator

Generator of index according to the use symbols of modules.


Field Summary
protected  CoopnSyntacticModule module
           
protected  int moduleKind
           
protected  java.util.List moduleList
           
protected  DocCommentParser parser
           
 
Fields inherited from class ConForM.CoopnTools.CoKer.DocComment.DocGenerator
doc, env, name, packageMgr
 
Constructor Summary
UsedIndexGenerator(DocWriter doc, CoopnSyntacticModule module, java.util.List moduleList, int moduleKind, PackageMgr packageMgr, CoopnEnv env)
          Constructor.
 
Method Summary
 void generateDocumentation()
           
 
Methods inherited from class ConForM.CoopnTools.CoKer.DocComment.DocGenerator
dispose, writeComment
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

parser

protected DocCommentParser parser

module

protected CoopnSyntacticModule module

moduleList

protected java.util.List moduleList

moduleKind

protected int moduleKind
Constructor Detail

UsedIndexGenerator

public UsedIndexGenerator(DocWriter doc,
                          CoopnSyntacticModule module,
                          java.util.List moduleList,
                          int moduleKind,
                          PackageMgr packageMgr,
                          CoopnEnv env)
Constructor. Build a generator of index of use symbols. Symbols are collected in the main module, as well as an optional list of additional modules.
Parameters:
doc - the writer
module - the main module
moduleList - the list of additional modules, or null
moduleKind - the kind of all above modules (kind in the sense of the package manager)
packageMgr - the package manager
env - the environment
Method Detail

generateDocumentation

public void generateDocumentation()
Overrides:
generateDocumentation in class DocGenerator