Document how to include custom plantuml diagrams into generated javadoc

[alexriva]

Is it possible to add custom plantUml diagrams in the generated javadoc ?

Example

...
public class Test {
/**
* A method with custom plantuml sequence diagram
* @startuml
* actor1 -> actor2 : call method
* @enduml
*/
public void method1(...) {
...

[alexriva]

Solved using taglet org.jdrupes.taglets.plantUml.PlantUml

 <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <configuration>
      <taglet>org.jdrupes.taglets.plantUml.PlantUml</taglet>
      <tagletArtifact>
        <groupId>org.jdrupes.taglets</groupId>
        <artifactId>plantuml-taglet</artifactId>
        <version>2.0.1</version>
      </tagletArtifact>
      <doclet>nl.talsmasoftware.umldoclet.UMLDoclet</doclet>
      <docletArtifact>
        <groupId>nl.talsmasoftware</groupId>
        <artifactId>umldoclet</artifactId>
        <version>2.0.20</version>
       </docletArtifact>
       <additionalOptions>
       </additionalOptions>
     </configuration>
  </plugin>

[alexriva]

Solved

[sjoerdtalsma]

Reopening this as it might be a good idea to (finally) document this as I have gotten the question before.

[sjoerdtalsma]

@alexriva Thanks for asking and providing the solution 😉