JDK 9 RFR of JDK-8173164: Resolve remaining HTML5 issues in javax.lang.model.*
joe darcy
joe.darcy at oracle.com
Mon Jan 23 18:22:12 UTC 2017
Hi Martin,
Thanks for the review.
For better tooling interaction, I'll switch to the fully qualified name
for the links.
Also, upon closer examination, there are not incoming links to the
anchor so I'll just delete it.
Updated patch below.
Thanks,
-Joe
diff -r 50c877258ca9
src/java.compiler/share/classes/javax/lang/model/element/TypeElement.java
---
a/src/java.compiler/share/classes/javax/lang/model/element/TypeElement.java
Fri Jan 20 18:24:50 2017 -0800
+++
b/src/java.compiler/share/classes/javax/lang/model/element/TypeElement.java
Mon Jan 23 10:19:24 2017 -0800
@@ -35,8 +35,7 @@
* type is a kind of class and an annotation type is a kind of
* interface.
*
- * <p> <a name="ELEM_VS_TYPE"></a>
- * While a {@code TypeElement} represents a class or interface
+ * <p> While a {@code TypeElement} represents a class or interface
* <i>element</i>, a {@link DeclaredType} represents a class
* or interface <i>type</i>, the latter being a use
* (or <i>invocation</i>) of the former.
diff -r 50c877258ca9
src/java.compiler/share/classes/javax/lang/model/util/Elements.java
---
a/src/java.compiler/share/classes/javax/lang/model/util/Elements.java
Fri Jan 20 18:24:50 2017 -0800
+++
b/src/java.compiler/share/classes/javax/lang/model/util/Elements.java
Mon Jan 23 10:19:24 2017 -0800
@@ -91,7 +91,9 @@
* If the named module cannot be found, null is returned. One
situation where a module
* cannot be found is if the environment does not include modules,
such as
* an annotation processing environment configured for
- * a {@linkplain ProcessingEnvironment#getSourceVersion source
version} without modules. *
+ * a {@linkplain
+ * javax.annotation.processing.ProcessingEnvironment#getSourceVersion
+ * source version} without modules.
*
* @param name the name
* @return the named module element, or {@code null} if it cannot
be found
@@ -331,7 +333,9 @@
* If there is no module for the element, null is returned. One
situation where there is
* no module for an element is if the environment does not include
modules, such as
* an annotation processing environment configured for
- * a {@linkplain ProcessingEnvironment#getSourceVersion source
version} without modules. *
+ * a {@linkplain
+ * javax.annotation.processing.ProcessingEnvironment#getSourceVersion
+ * source version} without modules.
*
* @param type the element being examined
* @return the module of an element
On 1/23/2017 8:57 AM, Martin Buchholz wrote:
> It's good.
>
> There's a persistent ecosystem nuisance that tools don't recognize
> imports done purely for javadoc's benefit and complain. For this
> reason I generally use fully qualified @links in the javadoc, even
> though it's uglier.
>
>
> On Sun, Jan 22, 2017 at 4:45 PM, joe darcy <joe.darcy at oracle.com
> <mailto:joe.darcy at oracle.com>> wrote:
>
> Hello,
>
> Even after the fixes for JDK-8172458, there is still a lingering
> HTML5 compliance issue in javax.lang.model.* in addition to a few
> javadoc linkage problems. These should all be fixed; small patch
> below.
>
> With the patch, the code is doclint clean under both HTML 4.01 and
> HTML 5 output.
>
> (I thought the linkage problem would have been caught by the javac
> and javadoc build options, but apparently not.)
>
> Thanks,
>
> -Joe
>
> diff -r 50c877258ca9
> src/java.compiler/share/classes/javax/lang/model/element/TypeElement.java
> ---
> a/src/java.compiler/share/classes/javax/lang/model/element/TypeElement.java
> Fri Jan 20 18:24:50 2017 -0800
> +++
> b/src/java.compiler/share/classes/javax/lang/model/element/TypeElement.java
> Sun Jan 22 16:23:28 2017 -0800
> @@ -35,7 +35,7 @@
> * type is a kind of class and an annotation type is a kind of
> * interface.
> *
> - * <p> <a name="ELEM_VS_TYPE"></a>
> + * <p> <a id="ELEM_VS_TYPE"></a>
> * While a {@code TypeElement} represents a class or interface
> * <i>element</i>, a {@link DeclaredType} represents a class
> * or interface <i>type</i>, the latter being a use
> diff -r 50c877258ca9
> src/java.compiler/share/classes/javax/lang/model/util/Elements.java
> ---
> a/src/java.compiler/share/classes/javax/lang/model/util/Elements.java
> Fri Jan 20 18:24:50 2017 -0800
> +++
> b/src/java.compiler/share/classes/javax/lang/model/util/Elements.java
> Sun Jan 22 16:23:28 2017 -0800
> @@ -29,6 +29,7 @@
> import java.util.List;
> import java.util.Map;
>
> +import javax.annotation.processing.Pr
> <http://javax.annotation.processing.Pr>ocessingEnvironment;
> import javax.lang.model.AnnotatedConstruct;
> import javax.lang.model.element.*;
>
> @@ -91,7 +92,7 @@
> * If the named module cannot be found, null is returned. One
> situation where a module
> * cannot be found is if the environment does not include
> modules, such as
> * an annotation processing environment configured for
> - * a {@linkplain ProcessingEnvironment#getSourceVersion
> source version} without modules. *
> + * a {@linkplain ProcessingEnvironment#getSourceVersion
> source version} without modules.
> *
> * @param name the name
> * @return the named module element, or {@code null} if it
> cannot be found
> @@ -331,7 +332,7 @@
> * If there is no module for the element, null is returned.
> One situation where there is
> * no module for an element is if the environment does not
> include modules, such as
> * an annotation processing environment configured for
> - * a {@linkplain ProcessingEnvironment#getSourceVersion
> source version} without modules. *
> + * a {@linkplain ProcessingEnvironment#getSourceVersion
> source version} without modules.
> *
> * @param type the element being examined
> * @return the module of an element
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.openjdk.java.net/pipermail/compiler-dev/attachments/20170123/541ef866/attachment.html>
More information about the compiler-dev
mailing list