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 |
Modifier and Type | Method and Description |
---|---|
DocgenConfig |
ObjectDoc.getDocgenCfg()
Returns document generation specific configuration.
|
DocgenConfig |
DocCollector.getDocgenCfg()
Returns configuration according to which the documentation is collected for generation.
|
Modifier and Type | Field and Description |
---|---|
private DocgenConfig |
DocCollectorImpl._docgenCfg |
private DocgenConfig |
AbstractObjectDoc._docgenCfg |
Modifier and Type | Method and Description |
---|---|
DocgenConfig |
DocCollectorImpl.getDocgenCfg() |
DocgenConfig |
AbstractObjectDoc.getDocgenCfg() |
Modifier and Type | Method and Description |
---|---|
private java.util.Map<java.lang.String,PackageDoc> |
DocCollectorImpl.buildPackageDocs(DocgenConfig docgenCfg,
java.util.Collection<UmlPackage> modelPackages)
Builds recursively package docs for
modelPackages ; every instance will add
itself with DocCollectorImpl.addToFlattened(PackageDoc) method to flattened map, and with
DocCollectorImpl.addToScoped(PackageDoc) to scoped mapd of retained packages. |
private static PropertiesDoc |
ClassDocImpl.createAssocEndsDoc(DocgenConfig docgenCfg,
UmlClass c) |
private static PropertiesDoc |
ClassDocImpl.createAttributesDoc(DocgenConfig docgenCfg,
UmlClass c) |
private static java.util.List<FigureDoc> |
ClassDocImpl.createFiguresDoc(DocgenConfig docgenCfg,
UmlClass c) |
static java.lang.String |
PackageDocImpl.createHeadingText(DocgenConfig docgenCfg,
UmlPackage pckage) |
private static OperationsDoc |
ClassDocImpl.createOperationsDoc(DocgenConfig docgenCfg,
UmlClass c) |
private static java.lang.String |
PackageDocImpl.deduce61850PackageKind(DocgenConfig docgenCfg,
UmlPackage pckage) |
private NamespaceInfo |
PackageDocImpl.initNamespace(DocgenConfig docgenCfg,
UmlPackage pckage) |
Constructor and Description |
---|
AbbrPackageDoc(DocgenConfig docgenCfg,
java.util.List<UmlAttribute> attributes,
UmlPackage p)
Constructor.
|
AbstractObjectDoc(DocgenConfig docgenCfg,
UmlObject o,
java.lang.String what,
TextDescription description,
TextDescription htmlDescription,
boolean ignoreDesc,
java.lang.String headingText)
"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)
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)
Same as
AbstractPropertiesDoc.AbstractPropertiesDoc(DocgenConfig, UmlObject, String, String, String, TableSpec, String)
, 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)
Constructor.
|
CdcAttributesDoc(DocgenConfig docgenCfg,
UmlClass c)
Constructor.
|
ClassDocImpl(DocgenConfig docgenCfg,
UmlClass c,
int headingOffset)
Constructor.
|
CustomAssocEndsDoc(DocgenConfig docgenCfg,
UmlClass c)
Constructor.
|
CustomLiteralsDoc(DocgenConfig docgenCfg,
UmlClass c)
Constructor.
|
DaAttributesDoc(DocgenConfig docgenCfg,
TableSpec tableSpec,
UmlClass c)
Constructor.
|
DataIndexDoc(DocgenConfig docgenCfg,
java.util.Map<java.lang.String,java.util.List<UmlAttribute>> attributesPerName,
java.lang.String packageName)
Constructor.
|
DefaultAssocEndsDoc(DocgenConfig docgenCfg,
UmlClass c)
Constructor.
|
DefaultAttributesDoc(DocgenConfig docgenCfg,
UmlClass c)
Constructor.
|
DefaultLiteralsDoc(DocgenConfig docgenCfg,
UmlClass c) |
FcPackageDoc(DocgenConfig docgenCfg,
java.util.Collection<UmlAttribute> literals,
UmlPackage p)
Constructor.
|
FigureDocImpl(DocgenConfig docgenCfg,
UmlDiagram d)
Constructor.
|
FigureDocImpl(DocgenConfig docgenCfg,
UmlDiagram d,
TextDescription description,
TextDescription htmlDescription,
java.io.File pic,
java.lang.String showsWhat,
java.lang.String caption)
Constructor.
|
LnAttributesDoc(DocgenConfig docgenCfg,
UmlClass c)
Constructor.
|
LnMapPackageDoc(DocgenConfig docgenCfg,
java.util.List<UmlClass> classes,
UmlPackage p)
Constructor.
|
OperationsDoc(DocgenConfig docgenCfg,
UmlClass c)
Constructor.
|
PackageDocImpl(DocgenConfig docgenCfg,
UmlPackage pckage,
DocCollector collector)
Constructor, to be called on model package.
|
PackageDocImpl(DocgenConfig docgenCfg,
UmlPackage pckage,
DocCollector collector,
java.lang.String modelName,
int headingOffset) |
PresCondPackageDoc(DocgenConfig docgenCfg,
java.util.Collection<UmlAttribute> literals,
UmlPackage p)
Constructor.
|
TrgOpPackageDoc(DocgenConfig docgenCfg,
java.util.Collection<UmlAttribute> literals,
UmlPackage p)
Constructor.
|
Copyright 2009-2015 Tatjana (Tanja) Kostic