Skip to content

Commit b4cea07

Browse files
committed
doc: add maven javadoc-site and full-site profiles
Add two new profile for generating build reports and javadocs via the maven site plugin.
1 parent daa0a47 commit b4cea07

File tree

7 files changed

+388
-188
lines changed

7 files changed

+388
-188
lines changed

.gitattributes

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# default to binary
2-
#* binary
31

42
# Java source
53
*.java text diff=java eol=lf
@@ -27,3 +25,8 @@
2725
*.war binary
2826
*.jar binary
2927

28+
# Images
29+
*.jpg binary
30+
*.png binary
31+
*.gif binary
32+
*.ico binary

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
**/dependency-reduced-pom.xml
1111
**/buildNumber.properties
1212
**/.mvn/timing.properties
13-
# https://github.com/takari/maven-wrapper#usage-without-binary-jar
14-
**/.mvn/wrapper/maven-wrapper.jar
1513
snapshot/
14+
gh-pages/
15+
apidocs/
1616

1717
#
1818
# Eclipse

module/jsonurl-core/pom.xml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
<packaging>jar</packaging>
3333

3434
<name>${project.groupId}:${project.artifactId}</name>
35+
<url>https://www.jsonurl.org</url>
3536
<description>
3637
This is the JSON->URL core library. It implements a parser, as defined
3738
by the spec, with support for type parameters. Implementations for
@@ -42,12 +43,11 @@
4243
JSON->URL with a new interface/library/framework.
4344
</description>
4445

45-
<build>
46-
<plugins>
47-
<plugin>
48-
<groupId>org.apache.maven.plugins</groupId>
49-
<artifactId>maven-source-plugin</artifactId>
50-
</plugin>
51-
</plugins>
52-
</build>
46+
<distributionManagement>
47+
<site>
48+
<id>${project.artifactId}-site</id>
49+
<url>${project.baseUri}</url>
50+
</site>
51+
</distributionManagement>
52+
5353
</project>

module/jsonurl-jsonorg/pom.xml

Lines changed: 7 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,17 @@
3535
</properties>
3636

3737
<name>${project.groupId}:${project.artifactId}</name>
38+
<url>https://www.jsonurl.org</url>
3839
<description>
3940
This implements a JSON->URL parser using Douglas Crockford's original
4041
Java implementation of JSON.
4142
</description>
43+
<distributionManagement>
44+
<site>
45+
<id>${project.artifactId}-site</id>
46+
<url>${project.baseUri}</url>
47+
</site>
48+
</distributionManagement>
4249

4350
<dependencies>
4451
<dependency>
@@ -59,35 +66,4 @@
5966
<version>${org.json.parser}</version>
6067
</dependency>
6168
</dependencies>
62-
63-
<build>
64-
<pluginManagement>
65-
<plugins>
66-
<plugin>
67-
<artifactId>maven-javadoc-plugin</artifactId>
68-
<configuration>
69-
<offlineLinks>
70-
<offlineLink>
71-
<url>https://www.javadoc.io/doc/org.jsonurl/jsonurl-core/latest</url>
72-
<location>${project.basedir}/../jsonurl-core/target/apidocs</location>
73-
</offlineLink>
74-
<offlineLink>
75-
<url>https://junit.org/junit5/docs/${junit.version}/api</url>
76-
<location>https://junit.org/junit5/docs/${junit.version}/api</location>
77-
</offlineLink>
78-
<offlineLink>
79-
<url>https://www.javadoc.io/doc/org.json/json/${org.json.parser}</url>
80-
<location>${project.basedir}/src/main/javadoc/org.json</location>
81-
</offlineLink>
82-
</offlineLinks>
83-
</configuration>
84-
</plugin>
85-
</plugins>
86-
</pluginManagement>
87-
<plugins>
88-
<plugin>
89-
<artifactId>maven-source-plugin</artifactId>
90-
</plugin>
91-
</plugins>
92-
</build>
9369
</project>

module/jsonurl-jsr374/pom.xml

Lines changed: 8 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,18 @@
3535
</properties>
3636

3737
<name>${project.groupId}:${project.artifactId}</name>
38+
<url>https://www.jsonurl.org</url>
3839
<description>
3940
This implements a JSON->URL parser for the JSR-374 JSON interface.
4041
</description>
4142

43+
<distributionManagement>
44+
<site>
45+
<id>${project.artifactId}-site</id>
46+
<url>${project.baseUri}</url>
47+
</site>
48+
</distributionManagement>
49+
4250
<dependencies>
4351
<dependency>
4452
<groupId>org.jsonurl</groupId>
@@ -64,35 +72,4 @@
6472
<scope>test</scope>
6573
</dependency>
6674
</dependencies>
67-
68-
<build>
69-
<pluginManagement>
70-
<plugins>
71-
<plugin>
72-
<artifactId>maven-javadoc-plugin</artifactId>
73-
<configuration>
74-
<offlineLinks>
75-
<offlineLink>
76-
<url>https://www.javadoc.io/doc/org.jsonurl/jsonurl-core/latest</url>
77-
<location>${project.basedir}/../jsonurl-core/target/apidocs</location>
78-
</offlineLink>
79-
<offlineLink>
80-
<url>https://junit.org/junit5/docs/${junit.version}/api</url>
81-
<location>https://junit.org/junit5/docs/${junit.version}/api</location>
82-
</offlineLink>
83-
<offlineLink>
84-
<url>https://docs.oracle.com/javaee/7/api</url>
85-
<location>https://docs.oracle.com/javaee/7/api</location>
86-
</offlineLink>
87-
</offlineLinks>
88-
</configuration>
89-
</plugin>
90-
</plugins>
91-
</pluginManagement>
92-
<plugins>
93-
<plugin>
94-
<artifactId>maven-source-plugin</artifactId>
95-
</plugin>
96-
</plugins>
97-
</build>
9875
</project>

0 commit comments

Comments
 (0)