JDK 9 RFR of JDK-8175786: Fix small doc issues

joe darcy joe.darcy at oracle.com
Thu Feb 23 19:13:27 UTC 2017


Hello,

Further scrutiny of of javax.lang.model specification revealed a few doc 
issues which should be fixed.

Patch below.

The class AbstractTypeVisitor6 already has the correct "{@code 
v.visit(av, p)}" text.

I'm also using this bug as an opportunity to fix an incorrect summary in 
the recently pushed test TestPseudoTypeHandling.java.

Thanks,

-Joe

diff -r a7c2b2d0894c 
src/java.compiler/share/classes/javax/lang/model/element/TypeElement.java
--- 
a/src/java.compiler/share/classes/javax/lang/model/element/TypeElement.java 
Wed Feb 22 12:01:15 2017 -0800
+++ 
b/src/java.compiler/share/classes/javax/lang/model/element/TypeElement.java 
Thu Feb 23 11:10:39 2017 -0800
@@ -75,8 +75,9 @@
       * originating source of information about the type.  For example,
       * if the information about the type is originating from a source
       * file, the elements will be returned in source code order.
-     * (However, in that case the the ordering of elements, such as a
-     * default constructor, is not specified.)
+     * (However, in that case the the ordering of {@linkplain
+     * Elements.Origin#MANDATED implicitly declared} elements, such as
+     * default constructors, is not specified.)
       *
       * @return the enclosed elements in proper order, or an empty list 
if none
       *
diff -r a7c2b2d0894c 
src/java.compiler/share/classes/javax/lang/model/util/AbstractAnnotationValueVisitor6.java
--- 
a/src/java.compiler/share/classes/javax/lang/model/util/AbstractAnnotationValueVisitor6.java 
Wed Feb 22 12:01:15 2017 -0800
+++ 
b/src/java.compiler/share/classes/javax/lang/model/util/AbstractAnnotationValueVisitor6.java 
Thu Feb 23 11:10:39 2017 -0800
@@ -79,9 +79,9 @@
      protected AbstractAnnotationValueVisitor6() {}

      /**
-     * Visits an annotation value as if by passing itself to that
+     * Visits any annotation value as if by passing itself to that
       * value's {@link AnnotationValue#accept accept}.  The invocation
-     * {@code v.visit(av)} is equivalent to {@code av.accept(v, p)}.
+     * {@code v.visit(av, p)} is equivalent to {@code av.accept(v, p)}.
       * @param av {@inheritDoc}
       * @param p  {@inheritDoc}
       */
diff -r a7c2b2d0894c 
src/java.compiler/share/classes/javax/lang/model/util/AbstractElementVisitor6.java
--- 
a/src/java.compiler/share/classes/javax/lang/model/util/AbstractElementVisitor6.java 
Wed Feb 22 12:01:15 2017 -0800
+++ 
b/src/java.compiler/share/classes/javax/lang/model/util/AbstractElementVisitor6.java 
Thu Feb 23 11:10:39 2017 -0800
@@ -81,7 +81,7 @@
      /**
       * Visits any program element as if by passing itself to that
       * element's {@link Element#accept accept} method.  The invocation
-     * {@code v.visit(elem)} is equivalent to {@code elem.accept(v,
+     * {@code v.visit(elem, p)} is equivalent to {@code elem.accept(v,
       * p)}.
       *
       * @param e  the element to visit
diff -r a7c2b2d0894c 
test/tools/javac/processing/model/util/types/TestPseudoTypeHandling.java
--- 
a/test/tools/javac/processing/model/util/types/TestPseudoTypeHandling.java 
Wed Feb 22 12:01:15 2017 -0800
+++ 
b/test/tools/javac/processing/model/util/types/TestPseudoTypeHandling.java 
Thu Feb 23 11:10:39 2017 -0800
@@ -24,7 +24,7 @@
  /*
   * @test
   * @bug 8175335
- * @summary Test Elements.getPackageOf
+ * @summary Test Types methods on module and package TypeMirrors
   * @author  Joseph D. Darcy
   * @library /tools/javac/lib
   * @modules jdk.compiler



More information about the compiler-dev mailing list