Skip to content
This repository was archived by the owner on Nov 16, 2024. It is now read-only.

Commit 9cc9a2d

Browse files
author
Gerald Boersma
committed
Updated readme.
1 parent 9b7a8af commit 9cc9a2d

File tree

1 file changed

+12
-19
lines changed

1 file changed

+12
-19
lines changed

README.md

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -36,18 +36,6 @@ there are other options that are being explored (http://plantuml.sourceforge.net
3636

3737
NOTE: The doclet tool was completely changed in Java 9; uml-java-doclet will not work with any JDK later than 8.
3838

39-
### Building ###
40-
41-
Build using Maven:
42-
43-
mvn clean install
44-
45-
To see an example of the Javadocs for the uml-java-doclet source code, use the Javadoc target:
46-
47-
mvn javadoc:javadoc
48-
49-
Javadoc output is in target/site/apidocs.
50-
5139
### Installing ###
5240

5341
Use http://jitpack.io to automatically build and install the JAR file. Add the JitPack repository to your POM:
@@ -61,6 +49,8 @@ Use http://jitpack.io to automatically build and install the JAR file. Add the J
6149

6250
Note: Not published to Maven Central; this is a much easier alternative.
6351

52+
### Generating Updated Javadocs ###
53+
6454
To generate UML diagrams for your own project, add the following to your POM:
6555

6656
<build>
@@ -88,13 +78,9 @@ To generate UML diagrams for your own project, add the following to your POM:
8878
Note: Version 3+ of the maven-javadoc-plugin uses the `additionalOptions` tag to specify additional javadoc tags.
8979
The previous `additionalparam` tag no longer works correctly. Be sure to upgrade your POMs accordingly.
9080

91-
### Generating Javadocs to Different Folder ###
92-
Refer to: https://maven.apache.org/plugins-archives/maven-javadoc-plugin-3.2.0/examples/output-configuration.html
93-
for documentation on how to use standard doclet option to specify a different folder in which to generate javadocs.
94-
95-
### Specifying Options ###
81+
### Diagram Options ###
9682

97-
Options are specified as `additionalOption` tags in the POM.
83+
Options for the diagrams are specified as `additionalOption` tags in the POM.
9884

9985
|Option|Valid Values|Default|Description|
10086
|---|---|---|---|
@@ -106,10 +92,17 @@ Options are specified as `additionalOption` tags in the POM.
10692
|-exclude-classes|comma-separated|none|List of qualified class names to exclude from context diagrams|
10793
|-exclude-packages|comma-separated|none|List of qualified package names to exclude from context diagrams|
10894

109-
# Acknowlegments #
95+
### Tips ###
96+
97+
- To generate the Javadoc to a different folder, refer to:
98+
https://maven.apache.org/plugins-archives/maven-javadoc-plugin-3.2.0/examples/output-configuration.html
99+
for how to use specify the standard doclet option.
100+
101+
# Acknowledgments #
110102

111103
Many thanks to the folks at PlantUML (https://github.com/plantuml/plantuml) for their
112104
fantastic support.
105+
Thanks to @bcopy for the pointer to jitpack.
113106

114107
# License #
115108

0 commit comments

Comments
 (0)