gboersma / uml-java-doclet

Doclet to generate UML diagrams for Javadoc using PlantUML.
74 stars 29 forks source link

how can i use it with gradle? #14

Open raul-sr opened 4 years ago

raul-sr commented 4 years ago

What do I need to apply it in gradle?

el-hult commented 2 years ago

My attempt is

apply plugin: 'java'

repositories {
    mavenCentral()
    maven {url "https://jitpack.io"}
}
configurations {
    pumldoclet
}
dependencies {
    pumldoclet 'com.github.gboersma:uml-java-doclet:1.1'
}

javadoc {
    options.doclet = 'info.leadinglight.umljavadoclet.UmlJavaDoclet'
    options.docletpath = configurations.pumldoclet.files.toList()
}

but I cannot get it to run, since I have JDK 11, and this tool only works with JDK 8.

Please let me know if you have any luck making it run.

koppor commented 11 months ago

There is an alternative plantuml-taglet with following syntax:

/**
 * Description.
 *
 * <img src="example.svg">
 *
 * This package/class ...
 *
 * @plantUml example.svg
 * Alice -> Bob: Authentication Request
 * Alice <-- Bob: Authentication Response
 * 
 */

Result:

image

(Source code: https://github.com/mnlipp/jdrupes-taglets/blob/master/plantUml9/overview.md)