在不同项目之间交叉链接 java doc

Question

我无法让 javadoc 引用另一个项目的 API。

项目之间有严格的雇佣关系（“应用程序”项目引用的“公共”项目）。 这两个项目都构建得很好，因此不存在实际不存在的类和包的问题。

我的理解是，javadoc 没有像 Java 那样的构建路径，而是使用其他 javadoc 网站的链接。就能够生成 HTML 交叉引用而言，有一些非常合乎逻辑的原因。

我的尝试如下：

1. 我已经为公共项目构建了 javadoc
2. ，我将其放在 Intranet 上的 Web 服务器上，
3. 我将 API（在我的 Intranet 上）的链接添加到了应用程序项目中的 javadoc ant 任务。
4. 我尝试构建应用程序项目

Javadoc 仍然会输出以下形式的错误消息：

[javadoc] C:\Users\couling\workspace\app\src\com\blahblah\app\AppMain.java:14: package com.blahblah.common.foo does not exist
[javadoc] import com.blahblah.common.foo.Bar
[javadoc]                               ^

生成的 javadoc 项目之间没有交叉链接。

这两个项目的 ant 任务如下：

Common：

<javadoc 
         access="protected" 
         author="true" 
         classpath="." 
         destdir="out/doc/docs" 
         nodeprecated="false"
         nodeprecatedlist="false" 
         noindex="false" 
         nonavbar="false" 
         notree="false"
         packagenames="*"
         source="1.6" 
         sourcepath="src" 
         splitindex="true" 
         use="true" 
         version="true">
             <link href="http://download.oracle.com/javase/6/docs/api/" />
</javadoc>

App：

<javadoc 
         access="protected" 
         author="true" 
         classpath="." 
         destdir="out/doc/docs" 
         nodeprecated="false"
         nodeprecatedlist="false" 
         noindex="false" 
         nonavbar="false" 
         notree="false"
         packagenames="com.blahblah.app.*"
         source="1.6" 
         sourcepath="src" 
         splitindex="true" 
         use="true" 
         version="true">
             <link href="http://intranet.blahblah.com/api/common/docs/" />
             <link href="http://download.oracle.com/javase/6/docs/api/" />
</javadoc>

对于我需要做什么才能让 app 引用 common 有什么想法吗？

Answer 1

元素（或命令行 javadoc 的 -link 选项）仅有助于生成链接 - 但 Javadoc 在较早的点停止，它不能如果您的应用程序类引用了未知（常见）类，则它们确实可以与您的应用程序类一起使用。

在这方面，Javadoc 的工作方式与 Javac 类似 - 您必须以某种方式将其指向要使用的类，即它们必须位于类路径中。您可以使用 元素指向 jar 文件或类目录，或使用 元素指向源（如果你需要继承他们的一些评论）。

链接到标准 API 不需要这样做，因为它已经包含在编译器中。

请注意，以这种方式链接需要 Javadoc 从此 URL 下载package-list - 您可以改为指向包含此 package-list 文件的本地目录。