Merge pull request #4838 from adangel/fix-javadoc-config

Fix javadoc/dokka configuration
This commit is contained in:
Juan Martín Sotuyo Dodero authored and GitHub committed 2024-02-29 08:59:48 -05:00
commit 3b9ee96840
6 files changed
+93 -5

No files matched your search

+18
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>
+9
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>
+13
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>
+17
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>
+18
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,
+18 -5
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>