Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8347399

Improve API documentation for java.lang.classfile.attribute

XMLWordPrintable

    • Icon: CSR CSR
    • Resolution: Approved
    • Icon: P4 P4
    • 24, 25
    • core-libs
    • 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.

            liach Chen Liang
            liach Chen Liang
            Adam Sotona
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: