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 |
---|---|
ModelFinder |
FreeFormDocumentation.getModelFinder() |
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 | Class and Description |
---|---|
class |
ModelFinderImpl
Provides methods for a writer to retreive UML model elements that are referenced by placeholders
in the input template document.
|
Constructor and Description |
---|
DocCollectorImpl(Config cfg,
ModelFinder modelFinder)
Constructs the instance to manually (through API) add documentation for package and other UML
objects.
|
Modifier and Type | Method and Description |
---|---|
ModelFinder |
WordWriterInput.getFinder()
Returns object that can find in the UML model items specified in placeholders.
|
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