Skip to content

Commit 0dcb11b

Browse files
committed
Javadoc: Add offline link to local aggregate javadocs
Assuming local docs/apidocs are up-to-date (see "Update site Apidocs" in PUBLISHING.md), building the individual modules with javadoc: mvn package -P release should create the necessary online links to any new resources/classes, not published already. Add some .mvn/ configuration (maven-enforcer-extension) – the presence of that directory is required to use ${maven.multiModuleProjectDirectory} reference in POM.
1 parent c09900a commit 0dcb11b

File tree

4 files changed

+34
-0
lines changed

4 files changed

+34
-0
lines changed

.mvn/enforcer-extension.xml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<extension>
2+
<executions>
3+
<execution>
4+
<configuration>
5+
<rules>
6+
<requireMavenVersion>
7+
<version>3.8.8</version>
8+
</requireMavenVersion>
9+
<requireJavaVersion>
10+
<version>21</version>
11+
</requireJavaVersion>
12+
</rules>
13+
</configuration>
14+
</execution>
15+
</executions>
16+
</extension>

.mvn/extensions.xml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<extensions xmlns="http://maven.apache.org/EXTENSIONS/1.1.0"
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:schemaLocation="http://maven.apache.org/EXTENSIONS/1.1.0
5+
https://maven.apache.org/xsd/core-extensions-1.1.0.xsd">
6+
<extension>
7+
<groupId>org.apache.maven.extensions</groupId>
8+
<artifactId>maven-enforcer-extension</artifactId>
9+
<version>3.4.1</version>
10+
</extension>
11+
</extensions>

.mvn/readme.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
The .mvn directory is needed to be able to use the ${maven.multiModuleProjectDirectory} property.

pom.xml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,12 @@
187187
><strong><a href="]]>${project.scm.url}<![CDATA[" style="text-transform: none; font-style: italic"
188188
>]]>${project.name} ${project.version}<![CDATA[</a></strong></div>]]></header>
189189
<bottom>Public domain {inceptionYear}, {currentYear}</bottom>
190+
<offlineLinks>
191+
<offlineLink>
192+
<url>https://stanio.github.io/xbrz-java/apidocs/</url>
193+
<location>${maven.multiModuleProjectDirectory}/docs/apidocs/</location>
194+
</offlineLink>
195+
</offlineLinks>
190196
<additionalOptions>
191197
<additionalOption>--add-reads</additionalOption>
192198
<additionalOption>io.github.stanio.xbrz.tool=io.github.stanio.xbrz.awt</additionalOption>

0 commit comments

Comments
 (0)