Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "Eclipse/API Central"

m (Fixed two broken links to eclipsecon.org.)
(39 intermediate revisions by 8 users not shown)
Line 1: Line 1:
(under construction)
+
This page is a hub to collect information about [[Eclipse Project]] APIs. 
  
This page is intended to become a hub to collect information about Eclipse project APIs.  To start, here are some links:
+
===API Guidelines ===
* [http://www.eclipse.org/articles/Article-API%20use/eclipse-api-usage-rules.html How to use the Eclipse API] Guidelines for using Eclipse APIs to ensure that your code will keep working as Eclipse evolves.
+
 
* [http://www.eclipse.org/eclipse/development/java-api-evolution.html Evolving Java-based APIs] Guidelines for how to evolve Java-based APIs while maintaining compatibility with existing client code.
+
* [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.  
 +
* [[Javadoc]] How to write Javadoc
 +
* [[Provisional API Guidelines]]
 +
* [[Eclipse/API Central/API Removal Process|API Removal Process]]
 +
* [[Eclipse/API Central/Deprecation Policy|Deprecation Policy]]
 +
* [[Export-Package | 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
 +
** [[Naming_Conventions]]
 +
* [[SPI description]]
 +
* [[Architecture Council/Metadata File Naming Recommendations|Metadata File Naming Recommendations]]
 +
 
 +
=== Useful links ===
 +
 
 +
* [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
* [[post_freeze_changes_3.2 | Late-breaking 3.2 API changes]]
 
* [[Provisional API Guidelines]]
 
 
* [[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]
 +
* [https://blogs.oracle.com/darcy/entry/kinds_of_compatibility Article on compatibility by Joseph Darcy from the Sun/Oracle JDK team]
 +
 +
=== Historical information ===
 +
 +
* [[post_freeze_changes_3.2 | Late-breaking 3.2 API changes]]
 +
 +
[[Category:API]]
 +
[[Category:Eclipse Project]]

Revision as of 11:48, 16 January 2018

This page is a hub to collect information about Eclipse Project APIs.

API Guidelines

Useful links

Historical information

Back to the top