【问题标题】:Usage of Eclipse PDE API ToolingEclipse PDE API 工具的使用
【发布时间】:2014-12-29 07:45:40
【问题描述】:

我们公司的几个团队使用内部框架来构建 Eclipse UI。该框架由一组 Eclipse 插件组成。

我们的团队负责开发此框架,我们正在寻找一些工具来检查我们框架的后续版本中的 API 损坏情况。

例如,我们有以下类:

package com.foo.A;

class A {
    public void doSmth() {}
}

目前在 MANIFEST 中,我们和我们插件的用户不指定任何版本的插件依赖项(始终与最新版本兼容)。

如果我们更改此类中的某些内容,我们希望 Eclipse 发出一些警告,例如更改方法签名或其他内容。在这种情况下,我们希望 Eclipse 建议我们提高插件的版本。

我已阅读以下有关 Eclipse 中的 API 工具的信息: https://wiki.eclipse.org/PDE/API_Tools/User_Guide

但在我看来,这个工具只适用于 Eclipse 原生插件,而不适用于我们定制开发的插件。

如果我弄错了,谁能解释一下如何为我们的插件设置 API 工具?

【问题讨论】:

标签: eclipse eclipse-plugin eclipse-pde pde


【解决方案1】:

Eclipse API 工具也适用于用户捆绑包。您应该做的是获取已发布的框架并将其定义为基线。一个快速的解决方案是将所有构建和发布到一个文件夹中的公共包中,并将该文件夹设置为基线:

Window - Preferences - Plug-in Development - API Baselines - [Add Baseline...]

例如,如果您必须修补旧版本的框架,您可以有多个基线。请务必在需要时设置您的API Errors/Warnings

编辑:当然,您应该在所有捆绑包中启用 API 工具,如您链接的网页中的“为 API 工具配置捆绑包”中所述!

【讨论】:

  • 问题是,在为 API 工具配置我的项目后,如页面中所述,我已链接没有任何标签添加到我的源代码中。我做错了什么?
  • 所以现在我有类似“<class name> 类型已从 <plugin name>_<plugin version> 中删除”之类的错误
  • javadoc 标签是不是自动生成的。这是你必须要做的事情。从您的第二条评论中,我认为您已经成功了!从导出的包中删除一个类是 api 损坏,并且必须增加包的主要版本。您收到的错误消息应附有一条错误消息,说明您应该增加主要版本。
猜你喜欢
  • 2010-11-15
  • 2011-05-29
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2011-11-21
  • 1970-01-01
相关资源
最近更新 更多