https://github.com/talsma-ict/umldoclet

Automatically generate PlantUML diagrams in javadoc
https://github.com/talsma-ict/umldoclet

code-analysis diagram doclet generator javadoc plantuml uml

Last synced: about 1 month ago
JSON representation

Automatically generate PlantUML diagrams in javadoc

• Host: GitHub
• URL: https://github.com/talsma-ict/umldoclet
• Owner: talsma-ict
• License: apache-2.0
• Created: 2016-02-18T11:49:03.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2025-12-03T10:06:05.000Z (3 months ago)
• Last Synced: 2025-12-04T01:51:57.920Z (3 months ago)
• Topics: code-analysis, diagram, doclet, generator, javadoc, plantuml, uml
• Language: Java
• Homepage:
• Size: 92.7 MB
• Stars: 253
• Watchers: 9
• Forks: 31
• Open Issues: 16
• Metadata Files:
  • Readme: readme.md
  • Contributing: .github/contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Maven Version][maven-img]][maven]

[![Javadoc][javadoc-img]][javadoc]

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=talsma-ict_umldoclet&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=talsma-ict_umldoclet)

[![Coverage Status][coveralls-img]][coveralls]

# UMLDoclet

[Doclet for javadoc][doclet] to automatically add [UML diagrams][plantuml] to Java documentation.  

## Generate UML diagrams

The UML Doclet uses available javadoc metadata to automatically generate

the following UML diagrams and embeds them in your HTML documentation.

The diagrams are embedded as clickable SVG objects by default 

and link to package and class documentation where available.

### Package dependency diagram



_The UML Doclet will warn about (and optionally fail on) cyclic package dependencies._

The dependency diagram links to package documentation containing:

### Package diagram



The package diagram links to class documentation containing:

### Class diagram



(These examples are from the [latest UML Doclet javadoc][javadoc] page. Please feel free to take a look to get an idea of the final result)

## Requirements

To use the UML Doclet, the following is required.

- [Javadoc version 9][doclet] or higher.  

  For versions of javadoc from earlier JDKs, please use the [latest `1.x` UML Doclet version][v1.x].

  If you compile your java 8 or older javadocs with a more recent JDK (Javadoc version 9 or higher),

  you need to use the 2.x version.

- The UML Doclet, the [usage page][usage] shows how.

  An apache-licensed version of [PlantUML][plantuml] is already included in the umldoclet jar.

## Releases

Released versions can be found in the [maven central repository][maven]

or on [github](https://github.com/talsma-ict/umldoclet/releases).  

## Usage

- Please see the separate [usage page][Usage]

  on how to use the UML Doclet in your own Java projects.

## Feedback

- We welcome [new issues](https://github.com/talsma-ict/umldoclet/issues/new).

  Please search the [current issues](https://github.com/talsma-ict/umldoclet/issues)

  to avoid filing a duplicate.

- If at all possible, please provide an example when sending in bugs.

  This will make fixing them that much easier!

  

## Contributing

- See [the contribute page](https://github.com/talsma-ict/umldoclet/contribute) for this repository.

## Thanks

- First of all a big thanks to [Arnaud Roques](https://github.com/arnaudroques),

  the developer of the excellent [PlantUML project](https://github.com/plantuml/plantuml) 

  without whom this project wouldn't exist!

- And of course thank _you_ for using UML Doclet.

  I hope it may be of benefit to your project!

## License

- [Apache 2.0 license](./LICENSE)

  [coveralls-img]: 

  [coveralls]: 

  [codacy-img]: 

  [codacy]: 

  [maven-img]: 

  [maven]: 

  [javadoc-img]: 

  [javadoc]: 

  

  [usage]: 

  [v1.x]: 

  [plantuml]: 

  [doclet]: 

  [libexpat]: