Package nl.talsmasoftware.umldoclet

package nl.talsmasoftware.umldoclet

Doclet for the JavaDoc tool that generates UML diagrams from the code.

Released versions can be found in the maven central repository or on github.

This doclet uses JavaDoc metadata available to automatically generate the following UML diagrams and add them to your documentation:

• Class diagrams
• Package diagrams
• A package dependency diagram

The doclet will warn about (and optionally fail on) cyclic package dependencies.

Usage

Please see the separate Usage page on how to use the UML doclet in your own Java projects.

Examples

The javadoc of the UMLDoclet itself is probably a decent example of what the default settings provide for you:

• Main javadoc page
• Simple package example: nl.talsmasoftware.umldoclet.rendering
• Complex package example: nl.talsmasoftware.umldoclet.uml
• Class example: nl.talsmasoftware.umldoclet.rendering.indent.Indentation

Class Summary

Class	Description
UMLDoclet	UML doclet that generates PlantUML class diagrams from your java code just as easily as creating proper JavaDoc comments. It actually extends JavaDoc's StandardDoclet doclet to generate the regular HTML documentation.