将脱机模式下的javadoc链接配置为链接到本地副本
将脱机模式下的javadoc链接配置为链接到本地副本
提问于 2017-09-04 14:06:07
如何在脱机模式下创建链接到本地文件系统中文件的javadocs？
我正在为java包构建javadocs，并希望外部包(包括java.lang)的链接指向本地副本。这是通过设置如下的links属性来实现的：
<configuration>
<links>
<link>/usr/share/doc/default-jdk-doc/api/</link>
</links>
</configuration>但是，在脱机工作时，即使链接到javadocs的本地副本，links属性也会被忽略。我的理解是，在这种情况下，我应该使用offlineLinks，但我无法使它工作。
我为offlineLinks看到的所有文档都将url设置为外部URL，location设置为本地文件。用例似乎是通过使用本地副本来创建到外部服务器的链接。我尝试将url和location设置为相同的值，但这似乎被忽略了。
<offlineLinks>
<offlineLink>
<url>/usr/share/doc/default-jdk-doc/api/</url>
<location>/usr/share/doc/default-jdk-doc/api/</location>
</offlineLink>
</offlineLinks>我创建了一个最小的示例，作为一个github gist，我是这样调用的：
mvn --offline javadoc:javadoc它有一个以String为参数的包和方法。我希望javadocs创建一个指向文档的本地副本的链接，但是我却一直将String链接到docs.oracle.com。
回答 1
Stack Overflow用户
发布于 2017-09-08 15:44:33
javadoc程序将正确处理-links选项，即使它是一个本地目录，并且没有internet连接。问题在于maven javadoc插件忽略了脱机模式下的links属性。解决方案是通过additionalparam属性将该选项直接传递给javadoc程序，如下所示：
<configuration>
<additionalparam>-link /usr/share/doc/default-jdk-doc/api/</additionalparam>
</configuration>这有两个问题：
- 如果链接到许多不同的包，它会变得太长。理论上，应该能够在单个
-link参数中传递多个additionalparam选项。 additionalparam被否决了。但是，没有其他maven属性可以直接传递javadoc选项，因此希望它们不会实际删除它。
offlineLinks属性(它将映射到命令行选项-linkoffline )似乎确实需要一个外部URL。我不确定这是javadoc程序中的要求还是maven javadoc插件中的要求。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/46038794
复制相关文章
相似问题
腾讯云开发者
