@@ -9,12 +9,13 @@ builders. That made changing JUnit 4 especially difficult and sometimes impossib
99That's why JUnit 5 introduces a defined lifecycle for all publicly available interfaces,
1010classes, and methods.
1111
12- [[api-evolution-annotations ]]
13- === API Annotations
12+ [[api-evolution-version-and-status ]]
13+ === API Version and Status
1414
1515Every published artifact has a version number `<major>.<minor>.<patch>`, and all publicly
16- available interfaces, classes, and methods are annotated with {API}. The annotation's
17- `status` attribute can be assigned one of the following values:
16+ available interfaces, classes, and methods are annotated with {API} from the
17+ {API_Guardian} project. The annotation's `status` attribute can be assigned one of the
18+ following values.
1819
1920[cols="20,80"]
2021|===
@@ -39,8 +40,8 @@ value of lower stability.
3940[[api-evolution-experimental-apis]]
4041=== Experimental APIs
4142
42- The following table lists which APIs are currently marked as _experimental_. Caution
43- should be taken when relying on such APIs.
43+ The following table lists which APIs are currently designated as _experimental_ (via
44+ `@API(status = EXPERIMENTAL)`). Caution should be taken when relying on such APIs.
4445
4546|===
4647| Package Name | Class Name | Type
@@ -80,8 +81,9 @@ should be taken when relying on such APIs.
8081|===
8182
8283[[api-evolution-tooling]]
83- === Tooling Support
84+ === @API Tooling Support
8485
85- The JUnit team plans to provide native tooling support for all JUnit users, extenders,
86- and tool builders. The tooling support will likely provide a means to check if the JUnit
87- APIs are being used in accordance with `@API` annotation declarations.
86+ The {API_Guardian} project plans to provide tooling support for publishers and consumers
87+ of APIs annotated with {API}. For example, the tooling support will likely provide a
88+ means to check if JUnit APIs are being used in accordance with `@API` annotation
89+ declarations.
0 commit comments