-
CSR
-
Resolution: Approved
-
P4
-
None
-
minimal
-
Additions to API specifications have no compatibility risk.
-
Java API
-
SE
Summary
Massive improvements to the documentation of java.lang.classfile.attribute
and other attribute related classes in java.lang.classfile
.
Problem
The java.lang.classfile.attribute
package is shipped with bare documentation. Additional documentation may help users to better understand the peculiarities and usages of each attribute, and best practices with attributes overall.
Solution
Normalize the attribute documentation to link to the mappers, and add special notes for attributes that need special attention. Add missing exception clauses. Add link to related core reflection/module APIs for some attributes. Many more detailed descriptions to user-defined attribute support infrastructure.
Specification
See attached apidiff. Note that latest javadoc and apidiff will be uploaded to CR soon as well.
- csr of
-
JDK-8342466 Improve API documentation for java.lang.classfile.attribute
- Resolved
- links to