为没有源码的Eclipse插件提供javadoc插件

Providing javadoc plug-in for Eclipse plug-ins without source code

我制作了一个由 Eclipse RCP 平台和我自己的 ~20 个 Eclipse 插件组成的 RCP 应用程序(暂且将其命名为 SDK)。现在我需要把这个SDK提供给其他开发者,他们会做插件,用这个SDK来扩展应用的功能。因此,我使用 Tycho 构建了插件,并将二进制文件提供给初级人员,让他们在 IDE 中将其用作目标平台。但显然,开发人员在 Eclipse IDE 中看不到 javadoc,这使他们的工作更加困难。不幸的是,我无法向他们提供这些包的源代码,因此提供源包的明显解决方案是不可接受的。我可以单独生成 javadoc 并告诉开发人员在 IDE 中手动附加它,但是那是很多插件并且 IDE 不会将 javadoc 附件持久保存到所需的包中。

问题是,一般来说,制作没有源代码的仅 javadoc 包的正确方法是什么,Eclipse IDE 会自动将其用作 javadoc 源?

我已经成功创建了插件(如 com.acme.sdk.doc),其中生成了适用于我的平台的 javadoc 并使用 tycho 存储-文档包。然后我将这个插件安装到 Eclipse IDE 中,我的目标平台设置在那里,希望这个包中的 javadoc 目录有一些神奇之处。这是行不通的。然后我让 tycho 也为 javadoc 生成目录,并通过 org.eclipse.help.toc 扩展点注册了这个目录。然后,文档显示在 Eclipse 帮助中,但是当将光标悬停在我的 SDK 中的 类 上时,Java 编辑器仍然说没有附加 javadoc。最后尝试我也用 org.eclipse.pde.core.javadoc 扩展点注册了 javadoc,但这也不起作用。我也知道这个 类似的问题。有 tycho 插件和 PDE 扩展点,我觉得我很接近,只是找不到让 IDE 识别这个包的方法。

到目前为止我发现的唯一方法是为每个平台包生成 javadoc 并将其放在 doc 目录中的每个包中 - 这样 Eclipse IDE 神奇地找到了它。这里的缺点是我将不得不构建两个版本的 SDK:一个用于没有文档的生产,一个用于开发。

好吧,我想出了问题所在,所以我会 post 自己回答。包含 javadoc 和 org.eclipse.pde.core.javadoc 扩展定义的插件 必须在同一个目标平台 中,其中记录了插件。

之前我把所有的SDK插件都放到了初级IDE的Target Platform中,但是包含javadocs的插件放到了Eclipse的dropins目录下。 IDE 安装了它,出现了帮助贡献,但 PDE 不会解析 javadoc。将 javadoc 插件添加到目标平台后,解析开始正常工作。