在脱机模式下配置javadoc链接以链接到本地副本

bogh5gae 于 2021-07-03 发布在 Java

关注(0)|答案(1)|浏览(416)

如何在脱机模式下创建链接到本地文件系统中的文件的javadocs？
我正在为一个java包构建javadocs，需要外部包（包括 java.lang )指向本地副本。通过设置 links 像这样的财产：

<configuration>
  <links>
    <link>/usr/share/doc/default-jdk-doc/api/</link>
  </links>
</configuration>

然而 links 属性在脱机工作时被忽略，即使链接到javadocs的本地副本时也是如此。我的理解是，在这种情况下，我应该使用 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 相反。

Java Maven Javadoc maven-javadoc-plugin

来源：https://stackoverflow.com/questions/46038794/configure-javadoc-links-in-offline-mode-to-link-to-local-copy

1条答案

按热度按时间

wh6knrhe1#

javadoc程序将处理 -links 选项正确，即使它是一个本地目录，没有互联网连接也没有。问题是maven javadoc插件忽略了 links 属性处于脱机模式。解决方案是通过 additionalparam 像这样的财产：

<configuration>
  <additionalparam>-link /usr/share/doc/default-jdk-doc/api/</additionalparam>
</configuration>

这有两个问题：
如果链接到多个不同的包，它会变得太长。理论上讲，一个人应该能够通过多次考试 -link 在单个 additionalparam 参数。
这个 additionalparam 已弃用。但是，没有其他maven属性可以直接传递javadoc选项，所以希望它们不会实际删除它。
这个 offlineLinks 属性，该属性将Map到命令行选项 -linkoffline 似乎真的需要一个外部网址。我不确定这是javadoc程序还是maven javadoc插件中的一个要求。

赞(0）回复(0）举报 2021-07-03

我来回答

在脱机模式下配置javadoc链接以链接到本地副本

1条答案

相关问题

热门标签

最新问答