Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "PDE/API Tools"
< PDE
(→Usecases) |
|||
| (103 intermediate revisions by 10 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{API_Tools}} | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | == Introduction == | |
| − | + | API tooling will assist developers in API maintenance by reporting API defects such as binary incompatibilities, incorrect plug-in version numbers, missing or incorrect <code>@since</code> tags, and usage of non-API code between plug-ins. The tooling will be integrated in the Eclipse SDK and will be used in the automated build process. Specifically, the tooling is designed to do the following: | |
| − | + | * Identify binary compatibility issues between two versions of a software component or product. | |
| + | * Update version numbers for plug-ins (bundles) based on the Eclipse versioning scheme. | ||
| + | * Update <code>@since</code> tags for newly added classes, interfaces, methods, etc. | ||
| + | * Provide new Javadoc tags and code assist to annotate types with special restrictions. | ||
| + | * Leverage existing information (in <code>MANIFEST.MF</code>) to define the visibility of packages between bundles. | ||
| + | * Identify usage of non-API code between plug-ins. | ||
| + | * Identity leakage of non-API types into API. | ||
| + | * Identify usage of code from a JRE outside the bounds of the one specified in the bundle configuration (<code>MANIFEST.MF</code>). | ||
| − | + | == Present state == | |
| − | + | API tooling was released to the Eclipse SDK in the PDE project during the [http://www.eclipse.org/eclipse/development/eclipse_project_plan_3_4.html Eclipse 3.4] release. Our milestone development time line corresponds to that of the Eclipse SDK (currently in the 3.6 stream). | |
| − | + | == Planning == | |
| − | + | All planned items (and wishes) can be found on our [[PDE/Plan/3.6#API Tools|3.6 plan]] page. | |
| − | == | + | == Links == |
| − | + | [[PDE/API Tools/Tasks|Ant Tasks]] - Description of the Ant Tasks available in API Tools | |
| − | + | [[PDE/API_Tools/Restrictions|API Restrictions]] - Description of the restrictions supported on API types via Javadoc tags or annotations. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | [ | + | |
| − | + | ||
| − | [ | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | [ | + | [[ApiTools Architecture|API Tooling Architecture]] - High level description of the tooling's architecture. |
| − | + | [[Evolving Java-based APIs]] - What is considered an API in Eclipse. | |
| − | [ | + | [[Version Numbering]] - Guidelines on versioning plug-ins |
| − | [ | + | [[PDE/Incubator]] - New projects that might be incorporated into PDE in future. |
[http://www.eclipse.org/pde/pde-ui/ PDE UI Home Page] - The main PDE UI web site. | [http://www.eclipse.org/pde/pde-ui/ PDE UI Home Page] - The main PDE UI web site. | ||
| − | [[Category:API|API | + | [[Category:API|API Tools]] |
| − | [[Category:Equinox|API | + | [[Category:Equinox|API Tools]] |
| + | [[Category:PDE|API Tools]] | ||
| + | [[Category:Eclipse_Project|API Tools]] | ||
Latest revision as of 15:11, 5 June 2014
| API Tools | |
| Website | |
| Download | |
| Community | |
| Mailing List • Forums • IRC • mattermost | |
| Issues | |
| Open • Help Wanted • Bug Day | |
| Contribute | |
| Browse Source |
Contents
Introduction
API tooling will assist developers in API maintenance by reporting API defects such as binary incompatibilities, incorrect plug-in version numbers, missing or incorrect @since tags, and usage of non-API code between plug-ins. The tooling will be integrated in the Eclipse SDK and will be used in the automated build process. Specifically, the tooling is designed to do the following:
- Identify binary compatibility issues between two versions of a software component or product.
- Update version numbers for plug-ins (bundles) based on the Eclipse versioning scheme.
- Update
@sincetags for newly added classes, interfaces, methods, etc. - Provide new Javadoc tags and code assist to annotate types with special restrictions.
- Leverage existing information (in
MANIFEST.MF) to define the visibility of packages between bundles. - Identify usage of non-API code between plug-ins.
- Identity leakage of non-API types into API.
- Identify usage of code from a JRE outside the bounds of the one specified in the bundle configuration (
MANIFEST.MF).
Present state
API tooling was released to the Eclipse SDK in the PDE project during the Eclipse 3.4 release. Our milestone development time line corresponds to that of the Eclipse SDK (currently in the 3.6 stream).
Planning
All planned items (and wishes) can be found on our 3.6 plan page.
Links
Ant Tasks - Description of the Ant Tasks available in API Tools
API Restrictions - Description of the restrictions supported on API types via Javadoc tags or annotations.
API Tooling Architecture - High level description of the tooling's architecture.
Evolving Java-based APIs - What is considered an API in Eclipse.
Version Numbering - Guidelines on versioning plug-ins
PDE/Incubator - New projects that might be incorporated into PDE in future.
PDE UI Home Page - The main PDE UI web site.