您可以使用<links/>参数向外部项目添加交叉引用链接。例如:
<project> ... <reporting> (or <build>) <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>3.3.2</version> <configuration> <links> <link>http://commons.apache.org/dbcp/apidocs/</link> <link>http://commons.apache.org/fileupload/apidocs/</link> </links> ... </configuration> </plugin> </plugins> </reporting> (or </build>) ... </project>
重要提示:根据Javadoc 规范,所有给定的链接都应该有一个可获取的/package-list文件。
从 2.6 开始,您可以尝试检测项目依赖项的所有 Javadoc 链接。您需要使用<detectLinks/>参数。所有检测到的链接都基于默认的 Maven 约定。例如,如果您的项目依赖于Apache Commons Lang ,即:
<project> ... <dependencies> <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> <versions>2.4</version> </dependency> </dependencies> ... </project>
添加的 Javadoc 链接将是http://commons.apache.org/lang/apidocs。
从 2.6 开始,将添加一个Javadoc API链接,具体取决于您的项目使用的 JDK 版本。Javadoc API 的版本是从org.apache.maven.plugins : maven-compiler-plugin(在 ${project.build.plugins} 或 ${project. build.pluginManagement}),或通过 Javadoc Tool 可执行文件计算。如果要跳过此链接,则需要将<detectJavaApiLink/>配置为false。
注意:如果您使用的是不受支持的 JDK,例如 7.0,您可以使用<javaApiLinks/>参数添加其 Javadoc API url,即:
<configuration> <javaApiLinks> <property> <name>api_1.7</name> <value>http://download.java.net/jdk7/docs/api/</value> </property> </javaApiLinks> ... </configuration>
更多信息请参考<links/>参数。
如果您的项目有模块,当您的目标不是聚合器目标时,您可以向模块添加交叉引用链接。例如,如果您的项目有两个模块,即:
<project> ... <modules> <module>module1</module> <module>module2</module> </modules> ... </project>
module1 的offlineLinks将是/absolute/path/to/ module2 /target/site/apidocs并且module2的 offlineLinks将是/absolute/path/to/ module1 /target/site/apidocs。
重要提示:所有离线链接都基于 ${project.url}(如果存在)。
从 2.6 开始,您可以使用< detectOfflineLinks />参数禁用离线链接的交叉引用。
更多信息请参考<offlineLinks/>参数。