【问题标题】:Eclipse: Can a single JAR have more than one JavaDoc location attached?Eclipse:一个 JAR 可以附加多个 JavaDoc 位置吗?
【发布时间】:2010-10-06 23:03:59
【问题描述】:

我使用的是 Eclipse 3.4.1。

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

如果我拥有这两个包的源代码,并且在 Eclipse 项目中拥有该源代码,它就可以正常工作。但我希望能够在我只有 JAR 和 JavaDoc 的情况下让它工作。

【问题讨论】:

    标签: eclipse javadoc


    【解决方案1】:

    这不是一件容易的事,因为有关 javadocs 的信息存储在您项目的 .classpath 文件的 classpathentry 中,并且它由一个值(目录或存档)组成

    解决方案是构建一个包含当前 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

    【讨论】:

      猜你喜欢
      • 2022-01-08
      • 1970-01-01
      • 2012-12-17
      • 2018-12-02
      • 2010-10-06
      • 1970-01-01
      • 1970-01-01
      • 2023-03-14
      • 2011-03-01
      相关资源
      最近更新 更多