Skip to content

Commit 0087a8e

Browse files
committed
Hightlight of text element and clarification of API elements
1 parent be08bbf commit 0087a8e

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

docs/Provisional_API_Guidelines.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
2-
3-
Provisional API Guidelines
1+
Eclipse API and Provisional Guidelines
42
==========================
53

64
Contents
@@ -20,27 +18,35 @@ Contents
2018
Overview
2119
--------
2220

23-
[Eclipse quality](http://www.eclipse.org/projects/dev_process/eclipse-quality.php) APIs don't appear fully formed out of nowhere. All APIs undergo a development process, passing through many phases from initial embroyonic forms to real battle-hardened APIs with guarantees of long term support. It is important that API clients understand the state of the APIs in any given build of Eclipse. This document sets out guidelines for the Eclipse Project committers on how to indicate APIs that are still under development and subject to change. These guidelines are also useful for API clients who want to know about the state of a given API they are using.
21+
[Eclipse quality](http://www.eclipse.org/projects/dev_process/eclipse-quality.php) APIs don't appear fully formed out of nowhere.
22+
All APIs undergo a development process, passing through many phases from initial embroyonic forms to real battle-hardened APIs with guarantees of long term support.
23+
It is important that API clients understand the state of the APIs in any given build of Eclipse.
24+
This document sets out API guidelines for the Eclipse Project committers on how to indicate APIs that are still under development and subject to change.
25+
These guidelines are also useful for API clients who want to know about the state of a given API they are using.
2426

2527
The development cycle for each major and minor Eclipse project release has a milestone designated as the API freeze. The rules for development and treatment of APIs are different for the periods before and after this point, so this document outlines guidelines for both phases of the development cycle.
2628

2729
Definition of terms used in this document:
2830

29-
API package 
31+
**API package** 
3032

31-
Any package that does not contain the segment "internal" and which has not set the x-internal or the x-friends directive in the MANIFEST.MF. (see [Naming Conventions](/Naming_Conventions "Naming Conventions") for details)
33+
A package must be exported via the MANIFEST.MF to be considered API.
34+
However, any package that does contain the segment "internal" and which has not set the x-internal or the x-friends directive in the MANIFEST.MF is not API.
35+
See [Naming Conventions](/Naming_Conventions "Naming Conventions") for details)
3236

33-
Internal package 
37+
**Internal API**
3438

3539
Any Java package containing the segment "internal".
3640

37-
API element 
41+
**API element** 
3842

3943
A public Java class or interface in an API package, or a public or protected method or field in such a class or interface
4044

41-
Provisional API 
45+
**Provisional API**
4246

43-
An API element that has not existed in any release of the Eclipse project. All provisional API is subject to arbitrary change or removal without any notice. Although the [Eclipse quality](http://www.eclipse.org/projects/dev_process/eclipse-quality.php) guidelines distinguish between several forms of transient APIs, this document will refer to all non-final APIs simply as provisional APIs. Provisional API has set the x-internal or the x-friends directive in the MANIFEST.MF
47+
An API element that has not existed in any release of the Eclipse project.
48+
All provisional API is subject to arbitrary change or removal without any notice.
49+
Although the [Eclipse quality](http://www.eclipse.org/projects/dev_process/eclipse-quality.php) guidelines distinguish between several forms of transient APIs, this document will refer to all non-final APIs simply as provisional APIs. Provisional API has set the x-internal or the x-friends directive for the package in the MANIFEST.MF
4450

4551
Before the API freeze
4652
---------------------

0 commit comments

Comments
 (0)