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.
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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
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 writermodule
- the main modulemodules
- 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 managerenv
- 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 writermodules
- 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 managerenv
- the environment
generateDocumentation
public void generateDocumentation()
- Overrides:
generateDocumentation
in class DocGenerator