See: Description
Interface | Description |
---|---|
ClassDoc |
Data required for documentation of classes.
|
ClassScl | |
DocCollector |
Collects documentation content for the model packages available in
UmlModel , according to
configuration, without generating any document. |
EntryDoc |
Record (table row) representation of an object.
|
FigureDoc |
Data required for documentation of figures.
|
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 | |
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.
|
Class | Description |
---|---|
AGSpec |
Specific to IEC 61850 tables for logical nodes and common data classes, this simple data
structure holds definition for a valid group.
|
ColumnSpec |
Column specification.
|
DocgenConfig |
Subset of
Config relevant for documentation generation. |
DocIDHelper |
FIXME: Have to somehow deal with checks on uniqueness (without using UUIDs)...
|
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 name (like for MS
Word documentation).
|
GroupsSpec | |
RawDataImpl |
Default implementation.
|
TableSpec |
Information required to describe a table and its columns for generating documentation.
|
WAX |
String constants used for XML doc generation.
|
Enum | Description |
---|---|
EntryDoc.Kind |
Describes the kind of an entry, to facilitate document generation formatting.
|
Writer
, to actually output some
documentation.
Major interfaces and classes are:
DocCollector
- the collector of
documentation.
DocgenConfig
- configuration options specific
to document generation (such as what to include/exclude), whether to retain HTML documentation
and such.
DocgenConfig
- configuration options specific
to document generation (such as what to include/exclude), whether to retain HTML documentation
and such.
FreeFormDocumentation
- collected
documentation for free format printing, such as when using a template and placeholders, where you
can freely choose content to generate).
FixedFormDocumentation
- collected
documentation for fixed format printing, such as when printing relevant content for a name space.
ModelFinder
- interface defining thin set of
methods to do lookup into the model as required for document generation (allowed us to do
document generation tests without actually having the full model loaded and built from EA file).
The implementation of interfaces are all available in the impl
sub-package.
Copyright 2009-2015 Tatjana (Tanja) Kostic