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 "Eclipse/API Central"
< Eclipse
(→API Guidelines) |
(→API Guidelines) |
||
| Line 7: | Line 7: | ||
* [[Javadoc]] How to write Javadoc | * [[Javadoc]] How to write Javadoc | ||
* [[Provisional API Guidelines]] | * [[Provisional API Guidelines]] | ||
| + | * [[Eclipse/API Central/API Removal Process|API Removal Process]] | ||
* [[Eclipse/API Central/Deprecation Policy|Deprecation Policy]] | * [[Eclipse/API Central/Deprecation Policy|Deprecation Policy]] | ||
* [[Export-Package | Policy on use of Export-Package]] | * [[Export-Package | Policy on use of Export-Package]] | ||
Revision as of 09:24, 28 April 2010
This page is a hub to collect information about Eclipse Project APIs.
API Guidelines
- How to use the Eclipse API Guidelines for using Eclipse APIs to ensure that your code will keep working as Eclipse evolves.
- Evolving Java-based APIs Guidelines for how to evolve Java-based APIs while maintaining compatibility with existing client code.
- Javadoc How to write Javadoc
- Provisional API Guidelines
- API Removal Process
- Deprecation Policy
- Policy on use of Export-Package
- OSGi API Guidelines
- API Javadoc tags
- Version Numbering Guidelines on how to assign and evolve plug-in version numbers
- Development Conventions and Guidelines, including
- SPI description
Useful links
- Eclipse APIs: Line in the Sand (pdf) The philosophy, psychology, and sociology of APIs, EclipseCON 2004 presentation by Jim des Rivieres
- API First (pdf) Best practices for API development based, EclipseCON 2005 presentation by Jim des Rivieres
- API Tutorial 2006 at EclipseCon
- Eclipse APIs and Java 5 EclipseCon 2007 presentation
- PDE UI Incubator ApiTools Compare
- Eclipse Development Process and Quality APIs