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

Commit 459d961

Browse files
author
Gerald Boersma
committed
Updated readme and POM for jitpack.io.
1 parent 66af9d8 commit 459d961

File tree

2 files changed

+38
-23
lines changed

2 files changed

+38
-23
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,26 @@ Build using Maven:
4242

4343
mvn clean install
4444

45-
To see an example of the updated Javadocs, use the Javadoc target:
45+
To see an example of the Javadocs for the uml-java-doclet source code, use the Javadoc target:
4646

4747
mvn javadoc:javadoc
4848

4949
Javadoc output is in target/site/apidocs.
5050

5151
### Installing ###
5252

53-
To generate UML diagrams for your own project, add the following to your pom.xml. You will need to build
54-
the project from scratch in your local environment; the distribution has not yet been uploaded to
55-
Maven Central:
53+
Use http://jitpack.io to automatically build and install the JAR file. Add the JitPack repository to your POM:
54+
55+
<repositories>
56+
<repository>
57+
<id>jitpack.io</id>
58+
<url>https://jitpack.io</url>
59+
</repository>
60+
</repositories>
61+
62+
Note: Not published to Maven Central; this is a much easier alternative.
63+
64+
To generate UML diagrams for your own project, add the following to your POM:
5665

5766
<build>
5867
<plugins>
@@ -62,9 +71,9 @@ Maven Central:
6271
<configuration>
6372
<doclet>info.leadinglight.umljavadoclet.UmlJavaDoclet</doclet>
6473
<docletArtifact>
65-
<groupId>info.leadinglight</groupId>
74+
<groupId>com.github.gboersma</groupId>
6675
<artifactId>uml-java-doclet</artifactId>
67-
<version>1.0-SNAPSHOT</version>
76+
<version>1.1</version>
6877
</docletArtifact>
6978
<useStandardDocletOptions>true</useStandardDocletOptions>
7079
<additionalOptions>
@@ -76,7 +85,7 @@ Maven Central:
7685
</build>
7786

7887
Note: Version 3+ of the maven-javadoc-plugin uses the `additionalOptions` tag to specify additional javadoc tags.
79-
The previous `additionalparm` tag no longer works correctly. Be sure to upgrade your POMs accordingly.
88+
The previous `additionalparam` tag no longer works correctly. Be sure to upgrade your POMs accordingly.
8089

8190
### Generating Javadocs to Different Folder ###
8291
Refer to: https://maven.apache.org/plugins-archives/maven-javadoc-plugin-3.2.0/examples/output-configuration.html

pom.xml

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,26 @@
1111
<maven.compiler.source>1.8</maven.compiler.source>
1212
<maven.compiler.target>1.8</maven.compiler.target>
1313
</properties>
14+
<dependencies>
15+
<dependency>
16+
<groupId>sun.jdk</groupId>
17+
<artifactId>tools</artifactId>
18+
<version>1.5.0</version>
19+
<scope>system</scope>
20+
<systemPath>${java.home}/../lib/tools.jar</systemPath>
21+
</dependency>
22+
<dependency>
23+
<groupId>net.sourceforge.plantuml</groupId>
24+
<artifactId>plantuml</artifactId>
25+
<version>1.2020.4</version>
26+
</dependency>
27+
</dependencies>
28+
<repositories>
29+
<repository>
30+
<id>jitpack.io</id>
31+
<url>https://jitpack.io</url>
32+
</repository>
33+
</repositories>
1434
<build>
1535
<plugins>
1636
<plugin>
@@ -43,9 +63,9 @@
4363
<configuration>
4464
<doclet>info.leadinglight.umljavadoclet.UmlJavaDoclet</doclet>
4565
<docletArtifact>
46-
<groupId>info.leadinglight</groupId>
66+
<groupId>com.github.gboersma</groupId>
4767
<artifactId>uml-java-doclet</artifactId>
48-
<version>1.0-SNAPSHOT</version>
68+
<version>1.1</version>
4969
</docletArtifact>
5070
<useStandardDocletOptions>true</useStandardDocletOptions>
5171
<additionalOptions>
@@ -55,18 +75,4 @@
5575
</plugin>
5676
</plugins>
5777
</build>
58-
<dependencies>
59-
<dependency>
60-
<groupId>sun.jdk</groupId>
61-
<artifactId>tools</artifactId>
62-
<version>1.5.0</version>
63-
<scope>system</scope>
64-
<systemPath>${java.home}/../lib/tools.jar</systemPath>
65-
</dependency>
66-
<dependency>
67-
<groupId>net.sourceforge.plantuml</groupId>
68-
<artifactId>plantuml</artifactId>
69-
<version>1.2020.4</version>
70-
</dependency>
71-
</dependencies>
7278
</project>

0 commit comments

Comments
 (0)