Package | Description |
---|---|
org.gigipugni.jcleancim.mibgen | |
org.tanjakostic.jcleancim.docgen | |
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.collector.impl.ag | |
org.tanjakostic.jcleancim.docgen.writer |
Classes and interfaces responsible for document generation out of the UML model.
|
org.tanjakostic.jcleancim.docgen.writer.word |
Classes specific to writing MS documents.
|
org.tanjakostic.jcleancim.docgen.writer.word.doc |
Classes specific to writing MS documents by means of automation API through Java-COM bridge (Jacob); this implementation is
extremely slow (it requires MS Word application and its COM API is just slow), but it supports
both .doc and .docx MS Word formats.
|
org.tanjakostic.jcleancim.docgen.writer.word.docx |
Classes specific to writing MS documents in OpenXML format; this implementation is fast (it does
not require MS Word application), but it supports only .docx MS Word format.
|
org.tanjakostic.jcleancim.docgen.writer.xml |
Classes specific to writing IEC 61850 name space definition files.
|
Class and Description |
---|
DocgenConfig
Subset of
Config relevant for documentation generation. |
Class and Description |
---|
DocCollector
Collects documentation content for the model packages available in
UmlModel , according to
configuration, without generating any document. |
Class and Description |
---|
AGSpec
Specific to IEC 61850 tables for logical nodes and common data classes, this simple data
structure holds definition for a valid group.
|
BookmarkRegistry
Registry for bookmarks.
|
ClassDoc
Data required for documentation of classes.
|
ClassScl |
ColumnSpec
Column specification.
|
DocgenConfig
Subset of
Config relevant for documentation generation. |
EntryDoc
Record (table row) representation of an object.
|
EntryDoc.Kind
Describes the kind of an entry, to facilitate document generation formatting.
|
FigureDoc
Data required for documentation of figures.
|
FixedFormDocumentation
Documentation in the fixed form, such as for printing content per model nature and per name space
(as with XML output).
|
FormatInfo |
FreeFormDocumentation
Documentation in the free form, such as for printing content simply per package or class name
(like for MS Word documentation).
|
GroupsSpec |
IDHelper
Creates identifiers.
|
ModelFinder
Thin set of methods, allowing us to do document generation tests without actually having the full
model loaded and built from EA file.
|
ObjectDoc
Interface common to most kinds of documentation for the model.
|
PackageDoc
Data required for documentation of packages; documentation includes classes and sub-packages.
|
PackageScl |
PlaceholderSpec.Kind |
PropertiesDoc
Set of methods to allow table generation for constituents.
|
RawData
Simple wrapper for a map of key/value pairs, used to store raw, non-formatted and non- modified
data from the UML object for applications that do not work with UML objects and that may need to
provide formatting for printing different than the default.
|
TableSpec
Information required to describe a table and its columns for generating documentation.
|
Class and Description |
---|
AGSpec
Specific to IEC 61850 tables for logical nodes and common data classes, this simple data
structure holds definition for a valid group.
|
BookmarkRegistry
Registry for bookmarks.
|
ClassDoc
Data required for documentation of classes.
|
DocCollector
Collects documentation content for the model packages available in
UmlModel , according to
configuration, without generating any document. |
DocgenConfig
Subset of
Config relevant for documentation generation. |
EntryDoc
Record (table row) representation of an object.
|
EntryDoc.Kind
Describes the kind of an entry, to facilitate document generation formatting.
|
FigureDoc
Data required for documentation of figures.
|
FixedFormDocumentation
Documentation in the fixed form, such as for printing content per model nature and per name space
(as with XML output).
|
FormatInfo |
FreeFormDocumentation
Documentation in the free form, such as for printing content simply per package or class name
(like for MS Word documentation).
|
ModelFinder
Thin set of methods, allowing us to do document generation tests without actually having the full
model loaded and built from EA file.
|
ObjectDoc
Interface common to most kinds of documentation for the model.
|
PackageDoc
Data required for documentation of packages; documentation includes classes and sub-packages.
|
PropertiesDoc
Set of methods to allow table generation for constituents.
|
RawData
Simple wrapper for a map of key/value pairs, used to store raw, non-formatted and non- modified
data from the UML object for applications that do not work with UML objects and that may need to
provide formatting for printing different than the default.
|
TableSpec
Information required to describe a table and its columns for generating documentation.
|
Class and Description |
---|
AGSpec
Specific to IEC 61850 tables for logical nodes and common data classes, this simple data
structure holds definition for a valid group.
|
Class and Description |
---|
PlaceholderSpec
When using
FreeFormDocumentation , templates for doc generation have to use labels to
indicate where to insert the documentation of what element of the UML model into the output
document. |
Class and Description |
---|
BookmarkRegistry
Registry for bookmarks.
|
ClassDoc
Data required for documentation of classes.
|
FigureDoc
Data required for documentation of figures.
|
FreeFormDocumentation
Documentation in the free form, such as for printing content simply per package or class name
(like for MS Word documentation).
|
ModelFinder
Thin set of methods, allowing us to do document generation tests without actually having the full
model loaded and built from EA file.
|
PackageDoc
Data required for documentation of packages; documentation includes classes and sub-packages.
|
PropertiesDoc
Set of methods to allow table generation for constituents.
|
Class and Description |
---|
PropertiesDoc
Set of methods to allow table generation for constituents.
|
Class and Description |
---|
PropertiesDoc
Set of methods to allow table generation for constituents.
|
Class and Description |
---|
FixedFormDocumentation
Documentation in the fixed form, such as for printing content per model nature and per name space
(as with XML output).
|
Copyright 2009-2016 Tatjana (Tanja) Kostic