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 |
---|---|
PackageDoc |
FreeFormDocumentation.getPackageDoc(java.lang.String name) |
Modifier and Type | Method and Description |
---|---|
java.util.List<PackageDoc> |
PackageDoc.getChildPackageDocs()
Returns documentation for all the child packages of this package.
|
java.util.Map<Nature,java.util.Map<NamespaceInfo,java.util.Map<java.lang.String,PackageDoc>>> |
FixedFormDocumentation.getNsPackageDocs()
Returns retained scoped package docs per nature and per name space.
|
java.util.Map<java.lang.String,PackageDoc> |
FreeFormDocumentation.getPackageDocs() |
Modifier and Type | Method and Description |
---|---|
void |
DocCollector.addToFlattened(PackageDoc packageDoc)
Must be called for every newly created
PackageDoc that need not be skipped. |
void |
DocCollector.addToScoped(PackageDoc packageDoc)
Must be called by every newly created
PackageDoc that need not be skipped, if
owner is in scope and it needs to be included in the name space: adds the
packageDoc under appropriate nature and name space, no-op otherwise. |
Constructor and Description |
---|
FixedFormDocumentation(java.util.Map<Nature,java.util.Map<NamespaceInfo,java.util.Map<java.lang.String,PackageDoc>>> nsPackageDocs)
Constructor.
|
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 | Method and Description |
---|---|
void |
DocCollectorImpl.addToFlattened(PackageDoc packageDoc) |
void |
DocCollectorImpl.addToScoped(PackageDoc packageDoc) |
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,PackageDoc> |
WordWriterInput.getPackageDocs()
Returns "flattened" map of package documentation instances, with package name as key (to
allow to quickly find the package name from what is read in the placeholder).
|
Modifier and Type | Method and Description |
---|---|
Cursor<O> |
WordWriter.writeAbbrTable(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
AbstractWordWriter.writeAbbrTable(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
WordWriter.writeDataIndex(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
AbstractWordWriter.writeDataIndex(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
WordWriter.writeFcTable(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
AbstractWordWriter.writeFcTable(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
WordWriter.writeLnMapPackage(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
AbstractWordWriter.writeLnMapPackage(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
WordWriter.writePackage(Cursor<O> initCursor,
PackageDoc doc,
boolean isRoot)
Writes all related to a package.
|
Cursor<O> |
AbstractWordWriter.writePackage(Cursor<O> initCursor,
PackageDoc doc,
boolean isRoot) |
Cursor<O> |
WordWriter.writePresCondTable(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
AbstractWordWriter.writePresCondTable(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
WordWriter.writeSclEnum(Cursor<O> cursor,
PackageDoc packageDoc) |
Cursor<O> |
AbstractWordWriter.writeSclEnum(Cursor<O> cursor,
PackageDoc packageDoc) |
Cursor<O> |
WordWriter.writeTrgOpTable(Cursor<O> initCursor,
PackageDoc packageDoc) |
Cursor<O> |
AbstractWordWriter.writeTrgOpTable(Cursor<O> initCursor,
PackageDoc packageDoc) |
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