|
||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
See:
Description
Interface Summary | |
---|---|
Decorator | Decorator implementations have the opportunity to modify the DOM trees built by a Processor instance. |
DocumentCompiler | DocumentCompiler implementations do the work of plugging the various output documents from the transformation stage together. |
Transformer | Transformer implementations do the work of generating output based on the decorated Documents passed to them. |
Class Summary | |
---|---|
ConsolidatedTransformer | Generates a consolidated Document from the array of individual Document objects and allows subclasses to transform this instead. |
CsvDecorator | From the example in the Reference Docs. |
CsvTransformer | From the example in the Reference Docs. |
DocumentCompilerImpl | Default implementation of the DocumentCompiler interface. |
DotFileTransformer | Generates graphs from the context files, firstly transforming the XML to an intermediate .dot file that GraphViz uses to generate the actual images. |
EchoTransformer | Transformer that simply echoes the XML representation of the decorated DOM. |
FilenameAppenderStrategy | FilenameAppenderStrategy is a trivial implementation that simply appends a String to the end of the input file name in order to produce the output name. |
GraphVizDecorator | GraphVizDecorator is a configurable Decorator implementation that adds attributes to the DOM used by DotFileTransformer in generating input files for GraphViz. |
HtmlDecorator | HtmlDecorator decorates the DOM's with attributes used predominantly in the generation of HTML documentation. |
JavaDocDecorator | Decorator implementation that adds JavaDoc href's to beans based on their classes. |
SimpleDecorator | Abstract implementation of the Decorator interface which
simply iterates each Element in each Document
and calls the protected decorateElement method that
subclasses will implement. |
XslTransformer | Base implementation of the Transformer interface that uses
XSLT (via TRaX) in order to generate output files. |
Exception Summary | |
---|---|
InvalidTransformerException |
The output package holds classes used to actually generate beandoc documentation (usually HTML) and where appropriate, .dot files that the graphing engine will use to draw the graphs. A default XSLT implementation is included, but power users may wish to define their own implementation using different stylesheets or even different transform technologies (such as FreeMarker) for absolute control over all aspects of the output.
|
||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |