Package | Description |
---|---|
org.tanjakostic.jcleancim.docgen.collector |
This package defines interfaces and classes responsible for collecting documentation and figures
from the UML model, or freely initialised through the API without any UML model.
|
org.tanjakostic.jcleancim.docgen.collector.impl | |
org.tanjakostic.jcleancim.docgen.writer.word |
Classes specific to writing MS documents.
|
Modifier and Type | Method and Description |
---|---|
BookmarkRegistry |
ObjectDoc.getBmRegistry()
Returns the populated bookmark registry.
|
BookmarkRegistry |
FreeFormDocumentation.getBmRegistry() |
BookmarkRegistry |
DocCollector.getBmRegistry()
Returns bookmark registry populated from the UML model.
|
Constructor and Description |
---|
FreeFormDocumentation(ModelFinder modelFinder,
BookmarkRegistry bmRegistry,
java.util.Map<java.lang.String,PackageDoc> packageDocs,
java.util.Map<java.lang.String,ClassDoc> classDocs)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
BookmarkRegistry |
DocCollectorImpl.getBmRegistry() |
BookmarkRegistry |
AbstractObjectDoc.getBmRegistry() |
Modifier and Type | Method and Description |
---|---|
protected static java.lang.String |
AbstractObjectDoc.deduceBookmark(BookmarkRegistry bmRegistry,
UmlObject obj) |
Constructor and Description |
---|
AbstractObjectDoc(DocgenConfig docgenCfg,
UmlObject o,
java.lang.String what,
TextDescription description,
TextDescription htmlDescription,
boolean ignoreDesc,
java.lang.String headingText,
java.lang.String bookmarkID,
BookmarkRegistry bmRegistry)
"Centralised" constructor, allowing for instantiation both with and without a UML object, and
with and without descriptions, as follows:
|
AbstractPropertiesDoc(DocgenConfig docgenCfg,
UmlObject object,
java.lang.String what,
java.lang.String introText,
java.lang.String captionText,
TableSpec colSpec,
java.lang.String tableName,
BookmarkRegistry bmRegistry)
Creates an instance with a
EntryDoc.Kind.tableName entry (if
tableName is not null) and
EntryDoc.Kind.columnLabels entry (from
colSpec ) in the list of entries; use when you want to add
EntryDoc.Kind.data (and optionally,
EntryDoc.Kind.groupSubhead ) entries one by
one, after some complex processing. |
AbstractPropertiesDoc(DocgenConfig docgenCfg,
UmlObject object,
java.lang.String what,
TextDescription description,
TextDescription htmlDescription,
boolean ignoreDesc,
java.lang.String headingText,
java.lang.String introText,
java.lang.String captionText,
TableSpec colSpec,
java.lang.String tableName,
BookmarkRegistry bmRegistry)
Same as
AbstractPropertiesDoc.AbstractPropertiesDoc(DocgenConfig, UmlObject, String, String, String, TableSpec, String, BookmarkRegistry)
, but with explicit text and html documentation parameters; this is to support chained
construction for the needs of testing where we don't have UML objects but want to print
descriptions. |
Attributes61850Doc(DocgenConfig docgenCfg,
UmlObject object,
java.lang.String what,
java.lang.String headingText,
java.lang.String introText,
java.lang.String captionText,
TableSpec colSpec,
java.lang.String tableName,
BookmarkRegistry bmRegistry)
Constructor.
|
FigureDocImpl(DocgenConfig docgenCfg,
UmlDiagram d,
BookmarkRegistry bmRegistry)
Constructor.
|
FigureDocImpl(DocgenConfig docgenCfg,
UmlDiagram d,
TextDescription description,
TextDescription htmlDescription,
java.io.File pic,
java.lang.String showsWhat,
java.lang.String caption,
BookmarkRegistry bmRegistry)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
BookmarkRegistry |
WordWriterInput.getBookmarkRegistry()
Returns bookmarks registry (used for hyperlinks).
|
Constructor and Description |
---|
WordWriterInput(java.lang.String appVersion,
java.lang.String modelFileName,
boolean skipTiming,
java.util.Map<java.lang.String,PackageDoc> packageDocs,
java.util.Map<java.lang.String,ClassDoc> classDocs,
ModelFinder finder,
java.lang.String inTemplatePath,
java.lang.String outFilePath,
boolean useBinaryDoc,
boolean introToFigureBefore,
int saveRecloseEvery,
boolean isDeep,
boolean useHyperlinks,
BookmarkRegistry bmRegistry)
Constructor, useful to create an instance if you don't have configuration.
|
Copyright 2009-2016 Tatjana (Tanja) Kostic