-
CSR
-
Resolution: Approved
-
P4
-
None
-
source
-
minimal
-
Compatible updates to the source.
-
Java API
-
SE
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 animplSpec
tag.- Add explicit throws tag to
AbstractAnnotationValueVisitor6.visitUnknown
Specification
See attached specdiff JDK-8309964.specdiff.1.zip
- csr of
-
JDK-8309964 Use directed inheritDoc for javax.lang.model API
-
- Resolved
-