The blog at [2] explained to me how to add PlantUML to my Maven project, using the special plugin developed by jeluard1.
Just adding the following to the plugins did the trick:
<?xml version="1.0" encoding="UTF-8"?>
<plugin>
<groupId>com.github.jeluard</groupId>
<artifactId>plantuml-maven-plugin</artifactId>
<version>1.1</version>
<configuration>
<outputInSourceDirectory>false</outputInSourceDirectory>
<outputDirectory>${basedir}/target/site/apidocs</outputDirectory>
<sourceFiles>
<directory>${basedir}/src/main/java/</directory>
<includes>
<include>**/*.java</include>
</includes>
</sourceFiles>
</configuration>
<dependencies>
<dependency>
<groupId>net.sourceforge.plantuml</groupId>
<artifactId>plantuml</artifactId>
<version>8004</version>
</dependency>
</dependencies>
</plugin>
<plugin>
<groupId>com.github.jeluard</groupId>
<artifactId>plantuml-maven-plugin</artifactId>
<version>1.1</version>
<configuration>
<outputInSourceDirectory>false</outputInSourceDirectory>
<outputDirectory>${basedir}/target/site/apidocs</outputDirectory>
<sourceFiles>
<directory>${basedir}/src/main/java/</directory>
<includes>
<include>**/*.java</include>
</includes>
</sourceFiles>
</configuration>
<dependencies>
<dependency>
<groupId>net.sourceforge.plantuml</groupId>
<artifactId>plantuml</artifactId>
<version>8004</version>
</dependency>
</dependencies>
</plugin>
Netbeans and Maven
In Netbeans you can select Actions on your project to perform. There is a coupling between the action and the goals in Maven that are executed3.These can be changed by going to your Netbeans Project Properties (right-click your project, select properties) - select "Actions" - select "Generate Javadoc".
Then add the plantuml Maven goal, com.github.jeluard:plantuml-maven-plugin:generate. You're likely to end up with the following:
generate-sources javadoc:javadoc com.github.jeluard:plantuml-maven-plugin:generate
References
- [1] GitHub - jeluard/maven-plantuml-plugin
- https://github.com/jeluard/maven-plantuml-plugin
- [2] Smartics - Using PlantUML
- http://www.smartics.de/archives/1313
- [3] Netbeans - MavenBestPractices
- http://wiki.netbeans.org/MavenBestPractices
No comments:
Post a Comment