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 |
---|---|
ClassDoc |
FreeFormDocumentation.getClassDoc(java.lang.String qName) |
Modifier and Type | Method and Description |
---|---|
java.util.List<ClassDoc> |
PackageDoc.getClassDocs()
Returns documentation for all the classes in this package.
|
java.util.Map<java.lang.String,ClassDoc> |
FreeFormDocumentation.getClassDocs() |
Modifier and Type | Method and Description |
---|---|
void |
DocCollector.addToFlattened(ClassDoc classDoc)
Must be called for every newly created
ClassDoc that need not be skipped. |
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 | Method and Description |
---|---|
void |
DocCollectorImpl.addToFlattened(ClassDoc classDoc) |
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,ClassDoc> |
WordWriterInput.getClassDocs()
Returns "flattened" map of class documentation instances, with qualified class name as
key (to allow to quickly find the class name from what is read in the placeholder).
|
Modifier and Type | Method and Description |
---|---|
Cursor<O> |
WordWriter.writeClassFromPackage(Cursor<O> cursor,
ClassDoc doc,
Style headStyle)
Writes all related to a class at the end of range in
initCursor . |
Cursor<O> |
AbstractWordWriter.writeClassFromPackage(Cursor<O> cursor,
ClassDoc doc,
Style headStyle) |
Cursor<O> |
WordWriter.writeExplicitClass(Cursor<O> cursor,
ClassDoc doc)
Writes all related to a class, including the title, at the start of range in
cursor . |
Cursor<O> |
AbstractWordWriter.writeExplicitClass(Cursor<O> cursor,
ClassDoc doc) |
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