Package org.forgerock.doc.maven.pre

Class PlantUml

java.lang.Object

org.forgerock.doc.maven.pre.PlantUml

public class PlantUml
extends Object

Use PlantUML to generate images.

This class expects .txt files in the DocBook XML sources that contain PlantUML diagrams.

It transforms the files to images in the same directories as the files.

Constructor Summary

Constructors

Constructor	Description
PlantUml(AbstractDocbkxMojo mojo)	Constructor setting the Mojo that holds the configuration.

Method Summary

Modifier and Type	Method	Description
void	execute()	Run PlantUML on .txt files in the DocBook source files.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PlantUml

public PlantUml(AbstractDocbkxMojo mojo)

Constructor setting the Mojo that holds the configuration.

Parameters:

mojo - The Mojo that holds the configuration.

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Run PlantUML on .txt files in the DocBook source files.

Throws:

org.apache.maven.plugin.MojoExecutionException - Failed to run PlantUML.