ConForM.CoopnTools.CoKer.DocComment
Class TocGenerator

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

public class TocGenerator
extends DocGenerator

Generator of table of contents.


Field Summary
protected  java.lang.Object module
           
protected  int moduleKind
           
protected  java.util.Map[] modules
           
protected  DocCommentParser parser
           
protected  java.lang.String title
           
 
Fields inherited from class ConForM.CoopnTools.CoKer.DocComment.DocGenerator
doc, env, name, packageMgr
 
Constructor Summary
TocGenerator(DocWriter doc, CoopnSyntacticModule module, java.util.Map[] modules, int moduleKind, PackageMgr packageMgr, CoopnEnv env)
          Constructor.
TocGenerator(DocWriter doc, java.util.Map[] modules, 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

title

protected java.lang.String title

module

protected java.lang.Object module

modules

protected java.util.Map[] modules

moduleKind

protected int moduleKind
Constructor Detail

TocGenerator

public TocGenerator(DocWriter doc,
                    CoopnSyntacticModule module,
                    java.util.Map[] modules,
                    int moduleKind,
                    PackageMgr packageMgr,
                    CoopnEnv env)
Constructor. Build a table of contents of the given module, the items of which are already selected, in the parameter modules.
Parameters:
doc - the writer
module - the main module
modules - the items of the toc, as an array (indexes = module kinds) of maps, each map element associating a module name with a CoopnSyntacticSymbol, the comment of which is relevant.
moduleKind - the kind of the main module (kind in the sense of the package manager)
packageMgr - the package manager
env - the environment

TocGenerator

public TocGenerator(DocWriter doc,
                    java.util.Map[] modules,
                    PackageMgr packageMgr,
                    CoopnEnv env)
Constructor. Build a table of contents, the items of which are already selected, in the parameter modules. The title is "all modules"
Parameters:
doc - the writer
modules - the itms of the toc, as an array (indexes = module kinds) of maps, each map element associating a module name with a CoopnSyntacticSymbol, the comment of which is relevant.
packageMgr - the package manager
env - the environment
Method Detail

generateDocumentation

public void generateDocumentation()
Overrides:
generateDocumentation in class DocGenerator