org.java.plugin.tools.docgen
public final class DocGenerator extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
DocGenerator.Tool
Utility class to be used from JXP templates.
|
Constructor and Description |
---|
DocGenerator(PluginRegistry aRegistry,
PathResolver aPathResolver)
Constructs generator configured to use pre-defined set of templates.
|
DocGenerator(PluginRegistry aRegistry,
PathResolver aPathResolver,
java.io.File templatesFolder,
java.lang.String templatesEncoding)
Constructs generator configured to use custom templates located somewhere
in the local file system.
|
DocGenerator(PluginRegistry aRegistry,
PathResolver aPathResolver,
java.lang.String templatesPath,
java.lang.String templatesEncoding)
Constructs generator configured to use custom templates available in the
classpath.
|
Modifier and Type | Method and Description |
---|---|
void |
generate(java.io.File destDir)
Generates documentation for all registered plug-ins.
|
java.lang.String |
getDocumentationOverview() |
java.lang.String |
getOutputEncoding() |
java.lang.String |
getStylesheet() |
void |
setDocumentationOverview(java.lang.String aDocumentationOverview) |
void |
setOutputEncoding(java.lang.String encoding) |
void |
setStylesheet(java.lang.String aStylesheet) |
public DocGenerator(PluginRegistry aRegistry, PathResolver aPathResolver) throws java.lang.Exception
aRegistry
- plug-ins registryaPathResolver
- path resolverjava.lang.Exception
- if an error has occurredpublic DocGenerator(PluginRegistry aRegistry, PathResolver aPathResolver, java.lang.String templatesPath, java.lang.String templatesEncoding) throws java.lang.Exception
aRegistry
- plug-ins registryaPathResolver
- path resolvertemplatesPath
- path to templates (should be available in classpath)templatesEncoding
- templates characters encoding, if null
, system
default will be usedjava.lang.Exception
- if an error has occurredpublic DocGenerator(PluginRegistry aRegistry, PathResolver aPathResolver, java.io.File templatesFolder, java.lang.String templatesEncoding) throws java.lang.Exception
aRegistry
- plug-ins registryaPathResolver
- path resolvertemplatesFolder
- folder with templatestemplatesEncoding
- templates characters encoding, if null
, system
default will be usedjava.lang.Exception
- if an error has occurredpublic java.lang.String getDocumentationOverview()
public void setDocumentationOverview(java.lang.String aDocumentationOverview)
aDocumentationOverview
- documentation overview HTML contentpublic java.lang.String getStylesheet()
public void setStylesheet(java.lang.String aStylesheet)
aStylesheet
- CSS style sheet contentpublic java.lang.String getOutputEncoding()
public void setOutputEncoding(java.lang.String encoding)
encoding
- output files encoding name (default is UTF-8)public void generate(java.io.File destDir) throws java.lang.Exception
destDir
- target folderjava.lang.Exception
- if an error has occurredCopyright © 2004-2007 Dmitry Olshansky. All Rights Reserved.