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

Use directed inheritDoc for javax.lang.model API

    XMLWordPrintable

Details

    • CSR
    • Resolution: Approved
    • P4
    • 22
    • core-libs
    • None
    • source
    • minimal
    • Compatible updates to the source.
    • Java API
    • SE

    Description

      Summary

      Use the new directed inheritance feature of @inheritDoc to improve the structure of the javadoc in javax.lang.model and javax.annotation.processing.

      Problem

      Un-directed @inheritDoc is imprecise in its meaning. A refactoring pass to use @inheritDoc revealed several minor spec bugs and areas for improvement.

      Solution

      Systematically adopt directed @inheritDoc. The actual changes to the API are smaller than the patch would suggest; the updates in the rendered javadoc are:

      • Improvements to general spec vs implSpec for AbstractProcessor
      • Minor update to AbstractTypeVisitor8
      • Add explicit visitRecordComponent override to ElementScanner6; this changes where ElementScanner{7, 8, 9, 14} inherit the method from
      • SimpleTypeVisitor6: remove redundant text that was previous moved to an implSpec tag.
      • Add explicit throws tag to AbstractAnnotationValueVisitor6.visitUnknown

      Specification

      See attached specdiff JDK-8309964.specdiff.1.zip

      Attachments

        Issue Links

          Activity

            People

              darcy Joe Darcy
              darcy Joe Darcy
              Vicente Arturo Romero Zaldivar
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: