Fix javadoc/dokka configuration

This commit is contained in:
Andreas Dangel
2024-02-27 19:49:23 +01:00
parent ce347bd736
commit b036931995
6 changed files with 93 additions and 5 deletions

View File

@ -15,6 +15,24 @@
<name>PMD Ant Integration</name>
<description>Apache Ant integration for PMD.</description>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<!-- overrides the configuration from parent pom: we only have pmd-core yet -->
<offlineLinks combine.self="override">
<offlineLink>
<location>${project.basedir}/../pmd-core/target/apidocs</location>
<url>../../pmd-core/${project.version}</url>
</offlineLink>
</offlineLinks>
</configuration>
</plugin>
</plugins>
</build>
<dependencies>
<dependency>
<groupId>net.sourceforge.pmd</groupId>

View File

@ -33,6 +33,15 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<!-- overrides the configuration from parent pom: we have here no offline links yet -->
<offlineLinks combine.self="override"></offlineLinks>
</configuration>
</plugin>
</plugins>
</build>
<dependencies>

View File

@ -45,6 +45,19 @@
<plugin>
<groupId>org.jetbrains.dokka</groupId>
<artifactId>dokka-maven-plugin</artifactId>
<configuration>
<!-- overrides the configuration from parent pom: we have here only pmd-core and pmd-test available -->
<externalDocumentationLinks combine.self="override">
<link>
<url>https://docs.pmd-code.org/apidocs/pmd-core/${project.version}/</url>
<packageListUrl>file://${project.basedir}/../pmd-core/target/apidocs/element-list</packageListUrl>
</link>
<link>
<url>https://docs.pmd-code.org/apidocs/pmd-test/${project.version}/</url>
<packageListUrl>file://${project.basedir}/../pmd-test/target/apidocs/element-list</packageListUrl>
</link>
</externalDocumentationLinks>
</configuration>
</plugin>
</plugins>
</build>

View File

@ -19,6 +19,23 @@
<java.version>8</java.version>
</properties>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<!-- overrides the configuration from parent pom: we only have pmd-core yet -->
<offlineLinks combine.self="override">
<offlineLink>
<location>${project.basedir}/../pmd-core/target/apidocs</location>
<url>../../pmd-core/${project.version}</url>
</offlineLink>
</offlineLinks>
</configuration>
</plugin>
</plugins>
</build>
<dependencies>
<dependency>

View File

@ -16,6 +16,24 @@
<java.version>8</java.version>
</properties>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<!-- overrides the configuration from parent pom: we only have pmd-core yet -->
<offlineLinks combine.self="override">
<offlineLink>
<location>${project.basedir}/../pmd-core/target/apidocs</location>
<url>../../pmd-core/${project.version}</url>
</offlineLink>
</offlineLinks>
</configuration>
</plugin>
</plugins>
</build>
<dependencies>
<!--
hamcrest and junit are scope compile,

23
pom.xml
View File

@ -375,17 +375,16 @@
<detectOfflineLinks>false</detectOfflineLinks>
<offlineLinks>
<offlineLink>
<location>${project.basedir}/../pmd-lang-test/target/dokkaJavadocJar</location>
<url>../../pmd-lang-test/${project.version}</url>
<location>${project.basedir}/../pmd-core/target/apidocs</location>
<url>../../pmd-core/${project.version}</url>
</offlineLink>
<offlineLink>
<location>${project.basedir}/../pmd-test/target/apidocs</location>
<url>../../pmd-test/${project.version}</url>
</offlineLink>
<!-- core needs to be last, because the package "net.sourceforge.pmd.lang" is both in pmd-core and pmd-test -->
<offlineLink>
<location>${project.basedir}/../pmd-core/target/apidocs</location>
<url>../../pmd-core/${project.version}</url>
<location>${project.basedir}/../pmd-lang-test/target/dokkaJavadocJar</location>
<url>../../pmd-lang-test/${project.version}</url>
</offlineLink>
</offlineLinks>
</configuration>
@ -397,6 +396,20 @@
<version>${dokka.version}</version>
<configuration>
<skip>${dokka.skip}</skip>
<externalDocumentationLinks>
<link>
<url>https://docs.pmd-code.org/apidocs/pmd-core/${project.version}/</url>
<packageListUrl>file://${project.basedir}/../pmd-core/target/apidocs/element-list</packageListUrl>
</link>
<link>
<url>https://docs.pmd-code.org/apidocs/pmd-test/${project.version}/</url>
<packageListUrl>file://${project.basedir}/../pmd-test/target/apidocs/element-list</packageListUrl>
</link>
<link>
<url>https://docs.pmd-code.org/apidocs/pmd-lang-test/${project.version}/</url>
<packageListUrl>file:///${project.basedir}/../pmd-lang-test/target/dokkaJavadocJar/element-list</packageListUrl>
</link>
</externalDocumentationLinks>
</configuration>
<executions>
<execution>