Eclipse:单个JAR是否可以连接多个JavaDoc位置?

时间:2009-02-11 16:29:46

标签: eclipse javadoc

我正在使用Eclipse 3.4.1。

虽然这听起来很奇怪,但我希望能够在Eclipse项目中将多个JavaDoc位置附加到同一个JAR中。这个特殊的JAR包含两组JavaDoc的类。原因是它是一个OSGi包,它由第三方JAR和该JAR之上的其他第三方代码组成,以使其在OSGi中工作。

如果我有两个软件包的源代码,并且在Eclipse项目中有源代码,那么它可以正常工作。但是我希望能够在我拥有JAR和JavaDoc的情况下使用它。

1 个答案:

答案 0 :(得分:1)

不容易做,因为有关javadoc的信息存储在项目的classpathentry文件的.classpath中,并且它由一个值(目录或存档)组成< / p>

解决方案是构建一个包含当前javadoc的javadoc,并将该存档附加到jar中。


另一个解决方案(可能没有被eclipse正确解释:待测试)是指向外部文档的链接

使用relative links to the external docs的示例:

  

假设您有两个软件包,其文档是在Javadoc工具的不同运行中生成的,这些文档由相对路径分隔。
  在此示例中,软件包为com.apipackage,API和com.spipackage,SPI(服务提供接口)。   您希望文档位于docs/api/com/apipackagedocs/spi/com/spipackage   假设已经生成了API包文档,并且docs是当前目录,您可以通过运行以下文档来记录SPI包,其中包含指向API文档的链接:

C:> javadoc -d ./spi -link ../api com.spipackage

注意-link参数是相对于目标目录(docs / spi)。

所以可能是如果你只将第二个javadoc附加到jar,它可能会拾取第一个javadoc中记录的类......但我对此表示怀疑。 http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#linkrelativeexample