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
| (9 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{Warning|This page has been migrated to https://github.com/eclipse-platform/eclipse.platform/blob/master/docs/API_Central.md}} | ||
| + | |||
This page is a hub to collect information about [[Eclipse Project]] APIs. | This page is a hub to collect information about [[Eclipse Project]] APIs. | ||
===API Guidelines === | ===API Guidelines === | ||
| − | * [http://www.eclipse.org/articles/Article-API | + | * [http://www.eclipse.org/articles/Article-API-Use/index.html 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. | * [[Evolving Java-based APIs]] Guidelines for how to evolve Java-based APIs while maintaining compatibility with existing client code. | ||
* [[Javadoc]] How to write Javadoc | * [[Javadoc]] How to write Javadoc | ||
| Line 16: | Line 18: | ||
** [[Naming_Conventions]] | ** [[Naming_Conventions]] | ||
* [[SPI description]] | * [[SPI description]] | ||
| + | * [[Architecture Council/Metadata File Naming Recommendations|Metadata File Naming Recommendations]] | ||
=== Useful links === | === Useful links === | ||
| − | * [http://www.eclipsecon.org/2010/sessions/ | + | * [http://www.eclipsecon.org/2010/sessions/sessions818e.html?id=1427 API Design and Evolution] - EclipseCon 2010 presentation - full [http://dl.dropbox.com/u/1975868/EclipseCon2010-API-Design-and-Evolution.zip downloadable material as ZIP (3.5MB)] |
| − | + | * [http://www.infoq.com/presentations/effective-api-design Effective API Design]: 1 hr video by Joshua Bloch | |
| − | + | * [http://www.eclipsecon.org/2010/sessions/sessions229f.html?id=1343 Who took the cookie from the cookie jar?] - EclipseCon 2010 presentation on API Tooling by Olivier Thomann | |
| − | + | * [[PDE UI Incubator ApiTools Compare]] | |
| − | + | * [http://eclipse.org/eclipse/presentation/eclipsecon/API-Tutorial-EclipseCon-2007.pdf Eclipse APIs and Java 5] EclipseCon 2007 presentation | |
* [http://www.eclipse.org/eclipse/development/apis/Eclipse-APIs-Lines-in-the-Sand.pdf Eclipse APIs: Line in the Sand (pdf)] The philosophy, psychology, and sociology of APIs, EclipseCON 2004 presentation by Jim des Rivieres | * [http://www.eclipse.org/eclipse/development/apis/Eclipse-APIs-Lines-in-the-Sand.pdf Eclipse APIs: Line in the Sand (pdf)] The philosophy, psychology, and sociology of APIs, EclipseCON 2004 presentation by Jim des Rivieres | ||
* [http://www.eclipse.org/eclipse/development/apis/API-First.pdf API First (pdf)] Best practices for API development based, EclipseCON 2005 presentation by Jim des Rivieres | * [http://www.eclipse.org/eclipse/development/apis/API-First.pdf API First (pdf)] Best practices for API development based, EclipseCON 2005 presentation by Jim des Rivieres | ||
* [[API Tutorial 2006]] at EclipseCon | * [[API Tutorial 2006]] at EclipseCon | ||
* [http://www.eclipse.org/projects/dev_process/eclipse-quality.php Eclipse Development Process and Quality APIs] | * [http://www.eclipse.org/projects/dev_process/eclipse-quality.php Eclipse Development Process and Quality APIs] | ||
| − | * [ | + | * [https://blogs.oracle.com/darcy/entry/kinds_of_compatibility Article on compatibility by Joseph Darcy from the Sun/Oracle JDK team] |
=== Historical information === | === Historical information === | ||
Latest revision as of 10:44, 7 February 2024
This page has been migrated to https://github.com/eclipse-platform/eclipse.platform/blob/master/docs/API_Central.md
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
- Metadata File Naming Recommendations
Useful links
- API Design and Evolution - EclipseCon 2010 presentation - full downloadable material as ZIP (3.5MB)
- Effective API Design: 1 hr video by Joshua Bloch
- Who took the cookie from the cookie jar? - EclipseCon 2010 presentation on API Tooling by Olivier Thomann
- PDE UI Incubator ApiTools Compare
- Eclipse APIs and Java 5 EclipseCon 2007 presentation
- 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 Development Process and Quality APIs
- Article on compatibility by Joseph Darcy from the Sun/Oracle JDK team