JDK-8263026 : Add more documentation for the test framework
- Type: Sub-task
- Component: hotspot
- Sub-Component: compiler
- Affected Version: 17
- Priority: P4
- Status: Closed
- Resolution: Delivered
- Submitted: 2021-03-04
- Updated: 2021-08-19
- Resolved: 2021-06-08
The Version table provides details related to the release that this issue/RFE will be addressed.
Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.
To download the current JDK release, click here.
Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.
To download the current JDK release, click here.
| JDK 17 |
|---|
17Resolved  |
Description
The first level of documentation should be directly in the code, especially for the public interface method and classes that are exposed to the user. I suggest to use Javadocs for them. Another kind of documentation should be done with example tests which can serve as a template and explain all the possibilities of writing a test and using the test framework features. Additionally, we could provide an overview in the externally visible and easy to find OpenJDK Wiki page to summarize the most important points and links to the examples and/or other resource about the test framework.