Skip to content

Commit 0d7794f

Browse files
committed
update readme with graphviz-taglet
Signed-off-by: Stefan Niederhauser <[email protected]>
1 parent f190e7c commit 0d7794f

File tree

2 files changed

+24
-8
lines changed

2 files changed

+24
-8
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Use graphviz with pure java. Create graphviz models using java code and convert
1212
#### [Examples ](#user-content-examples)
1313
#### [Images ](#user-content-images)
1414
#### [Configuration ](#user-content-configuration)
15+
#### [Javadoc ](#javadoc)
1516

1617

1718
## How it works
@@ -351,4 +352,26 @@ g.fontAdjust(.87).render(Format.PNG).toFile(new File("example/ex6a.png"));
351352
[//]: # (end)
352353
<img src="https://rawgit.com/nidi3/graphviz-java/master/graphviz-java/example/ex6d.png" width="400">
353354
<img src="https://rawgit.com/nidi3/graphviz-java/master/graphviz-java/example/ex6a.png" width="400">
354-
355+
356+
## Javadoc
357+
To use graphviz inside javadoc comments, add this to `pom.xml`:
358+
```xml
359+
<build>
360+
<plugins>
361+
<plugin>
362+
<artifactId>maven-javadoc-plugin</artifactId>
363+
<version>3.1.0</version>
364+
<configuration>
365+
<taglet>guru.nidi.graphviz.GraphvizTaglet</taglet>
366+
<tagletArtifact>
367+
<groupId>guru.nidi</groupId>
368+
<artifactId>graphviz-taglet</artifactId>
369+
<version>0.8.6</version>
370+
</tagletArtifact>
371+
</configuration>
372+
</plugin>
373+
</plugins>
374+
</build>
375+
```
376+
To use this with JDK 9 or later, replace `<artifactId>graphviz-taglet</artifactId>`
377+
with `<artifactId>graphviz-taglet9</artifactId>`.

graphviz-taglet/pom.xml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,6 @@
2323
<version>${project.version}</version>
2424
</tagletArtifact>
2525
</configuration>
26-
<dependencies>
27-
<dependency>
28-
<groupId>${project.groupId}</groupId>
29-
<artifactId>graphviz-java</artifactId>
30-
<version>${project.version}</version>
31-
</dependency>
32-
</dependencies>
3326
</plugin>
3427
</plugins>
3528
</build>

0 commit comments

Comments
 (0)