public interface DocCollector
UmlModel
, according to
configuration, without generating any document. Results are available with
getFreeFormDocumentation()
and getFixedFormDocumentation()
.Modifier and Type | Method and Description |
---|---|
boolean |
addSkippedInformativePackage(java.lang.String qName)
Must be called by every newly created
PackageDoc that is to be skipped. |
void |
addToFlattened(ClassDoc classDoc)
Must be called for every newly created
ClassDoc that need not be skipped. |
void |
addToFlattened(PackageDoc packageDoc)
Must be called for every newly created
PackageDoc that need not be skipped. |
void |
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. |
void |
collect(UmlModel model)
Collects recursively documentation from UML model packages, their sub-packages, etc.
|
BookmarkRegistry |
getBmRegistry()
Returns bookmark registry populated from the UML model.
|
DocgenConfig |
getDocgenCfg()
Returns configuration according to which the documentation is collected for generation.
|
FixedFormDocumentation |
getFixedFormDocumentation()
Creates if not yet called and then returns documentation per package, indexed by nature.
|
FreeFormDocumentation |
getFreeFormDocumentation()
Creates if not yet called and then returns documentation per package, indexed by package name
for easy reference; if there were any two packages with the same name, retains only the first
one collected.
|
boolean |
isFromUml()
Returns whether this collector has been created from a UML model (as opposed to pure API
calls).
|
void collect(UmlModel model)
model
- UML model.java.lang.UnsupportedOperationException
- if this instance has not been created with an uderlying UML model.FreeFormDocumentation getFreeFormDocumentation()
FixedFormDocumentation getFixedFormDocumentation()
void addToFlattened(PackageDoc packageDoc)
PackageDoc
that need not be skipped.packageDoc
- package documentation to retain.void addToFlattened(ClassDoc classDoc)
ClassDoc
that need not be skipped.classDoc
- class documentation to retain.void addToScoped(PackageDoc packageDoc)
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.packageDoc
- boolean addSkippedInformativePackage(java.lang.String qName)
PackageDoc
that is to be skipped. Returns
whether qName
has been added to the collection of skipped informative package
names. Because it is intended to be used for logging only, we don't need objects (strings are
enough).qName
- qualified name of the package.BookmarkRegistry getBmRegistry()
DocgenConfig getDocgenCfg()
boolean isFromUml()
Copyright 2009-2016 Tatjana (Tanja) Kostic