<commit_before>[![Build Status][ci-img]][ci]
[![Maven Version][maven-img]][maven]
[![Javadoc][javadoc-img]][javadoc]

# UMLDoclet

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

[![Codacy Badge][codacy-img]][codacy]
[![Codebeat badge][codebeat-img]][codebeat]
[![Coverage Status][coveralls-img]][coveralls]

## 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

<p align="center"><a href="https://www.javadoc.io/doc/nl.talsmasoftware/umldoclet"><img src="https://javadoc.io/page/nl.talsmasoftware/umldoclet/2.0.9/package-dependencies.svg" width="60%" /></a></p>

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

The dependency diagram links to package documentation containing:

### Package diagram

<p align="center"><a href="https://www.javadoc.io/page/nl.talsmasoftware/umldoclet/latest/nl/talsmasoftware/umldoclet/rendering/indent/package-summary.html"><img src="https://javadoc.io/page/nl.talsmasoftware/umldoclet/2.0.9/nl/talsmasoftware/umldoclet/rendering/indent/package.svg" width="60%"/></a></p>

The package diagram links to class documentation containing:

### Class diagram

<p align="center"><a href="https://www.javadoc.io/page/nl.talsmasoftware/umldoclet/latest/nl/talsmasoftware/umldoclet/rendering/indent/Indentation.html"><img src="https://javadoc.io/page/nl.talsmasoftware/umldoclet/2.0.9/nl/talsmasoftware/umldoclet/rendering/indent/Indentation.svg" height="200"/></a></p>

(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].<commit_msg>Update diagrams in readme to latest version<commit_after>[![Build Status][ci-img]][ci]
[![Maven Version][maven-img]][maven]
[![Javadoc][javadoc-img]][javadoc]

# UMLDoclet

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

[![Codacy Badge][codacy-img]][codacy]
[![Codebeat badge][codebeat-img]][codebeat]
[![Coverage Status][coveralls-img]][coveralls]

## 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

<p align="center"><a href="https://www.javadoc.io/doc/nl.talsmasoftware/umldoclet"><img src="https://javadoc.io/page/nl.talsmasoftware/umldoclet/2.0.11/package-dependencies.svg" width="60%" /></a></p>

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

The dependency diagram links to package documentation containing:

### Package diagram

<p align="center"><a href="https://www.javadoc.io/page/nl.talsmasoftware/umldoclet/latest/nl/talsmasoftware/umldoclet/rendering/indent/package-summary.html"><img src="https://javadoc.io/page/nl.talsmasoftware/umldoclet/2.0.11/nl/talsmasoftware/umldoclet/rendering/indent/package.svg" width="60%"/></a></p>

The package diagram links to class documentation containing:

### Class diagram

<p align="center"><a href="https://www.javadoc.io/page/nl.talsmasoftware/umldoclet/latest/nl/talsmasoftware/umldoclet/rendering/indent/Indentation.html"><img src="https://javadoc.io/page/nl.talsmasoftware/umldoclet/2.0.11/nl/talsmasoftware/umldoclet/rendering/indent/Indentation.svg" height="200"/></a></p>

(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].
{'fraction_non_alphanumeric': 0.13501518336837187, 'fraction_numerical': 0.009577201588413922, 'mean_word_length': 5.659409020217729, 'pattern_counts': {'":': 0, '<': 33, '<?xml version=': 0, '>': 33, 'https://': 12, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1001058', 'n_tokens_mistral': 1484, 'n_tokens_neox': 1397, 'n_words': 351}