See: Description
Interface | Description |
---|---|
Range<O> |
Technology-independent abstraction for range in documents.
|
Writer |
Interface to be implemented by all the UML documentation writers.
|
Class | Description |
---|---|
AbstractRange<O> |
Common implementation.
|
AbstractWriter |
Common implementation for all writers.
|
Caption<O> |
Caption for figure or table.
|
Cursor<O> |
Simple association of placeholder and range.
|
CursorList<O> |
List of cursors.
|
Placeholder |
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. |
WriterInput |
Group of parameters to construct any documentation writer.
|
Enum | Description |
---|---|
Caption.CaptionKind | |
Style |
Maps document in-built styles as replacement for our desired styles (in IEC template), to allow
for doc generation even with a non-IEC template.
|
Interfaces are currently implemented for MS Word document generation only; we are working on
implementing serialisation in an XML format for documentation. Implementations are residing in
subpackages word
and xml
.
Main classes and interfaces are:
Writer
- interface to implement in order to
write the collected documentation.
WriterInput
- arguments to initialise any
writer.
Placeholder
- contains points in template
document that need to be replaced with the actual documentation content, or errors for invalid
formats or inexistant model elements.
TODO:
Copyright 2009-2016 Tatjana (Tanja) Kostic