java - 有没有办法在 Eclipse 中自动附加非 JRE 包的 Javadoc？

Question

首先，这与 Java SE Javadocs 无关。工作正常。

我们有一个基于 Java 的大型平台，包含大约 20 个 API 包。对于使用我们平台的用户，我们希望工具提示和其他此类内置文档支持能够像 Java API 那样发挥作用。

我们的 Javadoc 位于使用我们平台的用户可以访问的 URL，并且在使用通常的方法手动附加到引用的包时可以正常工作。

Eclipse 似乎没有保留 Javadoc 附件 - 也就是说，当您将 Javadoc 附加到 bundle 时，它可以工作，但是当您重新启动 Eclipse 时，该附件就会丢失。

如果至少有 20 个 API 包，并且使用我们平台的典型工作区至少有 10 个或更多项目，则必须手动将 Javadoc 附加到每个项目的每个引用包是行不通的(例如，可能有 200 个手动附件)重新启动 Eclipse 的时间。

有什么方法可以自动化吗？我并不排斥某种脚本解决方案，即使它必须在每次 Eclipse 启动时运行，但显然，如果它只是“工作”会更好，就像它对 Java API 所做的那样。 (就此而言，我希望它也适用于各种事物，例如 Apache Commons、Bouncy CaSTLe、Android 等)。

谢谢...

Answer 1

可以通过向目标平台提供包含 Javadoc 的 bundle (不包含源代码)来解决此问题。以下是实现这一目标的步骤:

1. 创建包含 API 完整 Javadoc 的插件
2. 通过org.eclipse.pde.core.javadoc extension point定义扩展在这个插件中是这样的:

<extension point="org.eclipse.pde.core.javadoc">
    <javadoc path="javadoc"> <!-- relative path to the API javadoc directory (can also be a URL) -->
        <plugin id="com.acme.core"/>
        <plugin id="com.acme.ui"/>
        <!-- list plug-ins which have been documented in the docs -->
    </javadoc>
</extension>

导出此插件并将其添加到目标平台

如果您的 Javadoc 已通过 URL 在线提供，您只需创建定义扩展的插件并将 URL 设置为 Javadoc 元素的路径即可:

<javadoc path="https://acme.com/apidocs">

Eclipse IDE 将通过 PDE 扩展自动解析您的包的 Javadoc 位置。