Package nl.talsmasoftware.umldoclet
Class UMLDoclet
java.lang.Object
jdk.javadoc.doclet.StandardDoclet
nl.talsmasoftware.umldoclet.UMLDoclet
- All Implemented Interfaces:
Doclet
UML doclet that generates PlantUML class diagrams from your java code just as
easily as creating proper JavaDoc comments.
It actually extends JavaDoc's
It actually extends JavaDoc's
StandardDoclet
doclet to generate the regular HTML documentation.- Author:
- Sjoerd Talsma
-
Nested Class Summary
Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Doclet
Doclet.Option
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetName()
Returns all supported options.void
boolean
run(DocletEnvironment environment)
Perform the main doclet functionality, processing all included elements.Methods inherited from class jdk.javadoc.doclet.StandardDoclet
getSupportedSourceVersion
-
Constructor Details
-
UMLDoclet
public UMLDoclet()Default constructor, as required by Doclet specification.
-
-
Method Details
-
init
- Specified by:
init
in interfaceDoclet
- Overrides:
init
in classStandardDoclet
- Parameters:
locale
- The locale to be used by this doclet.reporter
- The reporter to be used by this doclet.
-
getName
- Specified by:
getName
in interfaceDoclet
- Overrides:
getName
in classStandardDoclet
- Returns:
- The name of this doclet, minus the
"Doclet"
suffix since the StandardDoclet also returns just"Standard"
as its name.
-
getSupportedOptions
Returns all supported options. This includes the options from the StandardDoclet.- Specified by:
getSupportedOptions
in interfaceDoclet
- Overrides:
getSupportedOptions
in classStandardDoclet
- Returns:
- The set containing all supported options
-
run
Perform the main doclet functionality, processing all included elements.For each included class, a ClassDiagram is generated. For each included package, a PackageDiagram is genrated. Also, a DependencyDiagram is generated, containing all dependencies that were detected.
Depending on the Configuration, diagram images or
.puml
plantuml source files are generated.- Specified by:
run
in interfaceDoclet
- Overrides:
run
in classStandardDoclet
- Parameters:
environment
- The doclet environment from which essential information can be extracted- Returns:
true
if the doclet ran succesfully,false
in case of errors.
-