JDK 13 RFR of 8216335: Minor cleanups to javax.annotation.processing and javax.lang.model javadoc

Jonathan Gibbons jonathan.gibbons at oracle.com
Fri Jan 11 00:24:23 UTC 2019


What was wrong with href="http://www.ietf.org/rfc/rfc3986.txt">RFC 
3986</a> ?

Note there are lots of references to ietf.org rfc docs in our API docs; 
it would be nice if they were consistent. See the list reported by 
doccheck, about half-way down this page:

http://cr.openjdk.java.net/~jjg/doccheck/11/jdk-all/report.html

-- Jon


On 01/10/2019 04:02 PM, Joseph D. Darcy wrote:
> Hi Jan,
>
> Thanks for checking; that URL doesn't seem to work now for me either.
>
> I'll file a follow-up issue to change it to
>
>     https://www.rfc-editor.org/info/rfc3986
>
> which will hopefully be stable going forward.
>
> Cheers,
>
> -Joe
>
> On 1/10/2019 7:19 AM, Jan Lahoda wrote:
>> Looks OK to me except for:
>> > - * href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986</a>, section
>> > + * href="http://www.ietf.org/html/rfc3986.txt">RFC 3986</a>, section
>>
>> The new link does not seem to work for me.
>>
>> Jan
>>
>> On 8.1.2019 07:43, Joe Darcy wrote:
>>> Hello,
>>>
>>> A pass over the javax.annotation.processing and javax.lang.model specs
>>> revealed various areas for improvement.
>>>
>>> Please review the fixes to address those issues in the webrev and the
>>> corresponding patch below:
>>>
>>> http://cr.openjdk.java.net/~darcy/8216335.0/
>>>
>>> Thanks,
>>>
>>> -Joe
>>>
>>> --- 
>>> old/src/java.compiler/share/classes/javax/annotation/processing/AbstractProcessor.java 
>>> 2019-01-07 22:32:32.960000000 -0800
>>> +++ 
>>> new/src/java.compiler/share/classes/javax/annotation/processing/AbstractProcessor.java 
>>> 2019-01-07 22:32:32.756000000 -0800
>>> @@ -92,10 +92,10 @@
>>>        * same set of strings as the annotation.  If the class is not so
>>>        * annotated, an empty set is returned.
>>>        *
>>> -     * If the {@link ProcessingEnvironment#getSourceVersion source
>>> +     * If the {@linkplain ProcessingEnvironment#getSourceVersion 
>>> source
>>>        * version} does not support modules, in other words if it is 
>>> less
>>>        * than or equal to {@link SourceVersion#RELEASE_8 RELEASE_8},
>>> -     * then any leading {@link Processor#getSupportedAnnotationTypes
>>> +     * then any leading {@linkplain 
>>> Processor#getSupportedAnnotationTypes
>>>        * module prefixes} are stripped from the names.
>>>        *
>>>        * @return the names of the annotation types supported by this
>>> --- 
>>> old/src/java.compiler/share/classes/javax/annotation/processing/Filer.java 
>>> 2019-01-07 22:32:33.376000000 -0800
>>> +++ 
>>> new/src/java.compiler/share/classes/javax/annotation/processing/Filer.java 
>>> 2019-01-07 22:32:33.180000000 -0800
>>> @@ -60,7 +60,7 @@
>>>    * by {@code '/'}; {@code '.'} and {@code '..'} are invalid path
>>>    * segments.  A valid relative name must match the
>>>    * "path-rootless" rule of <a
>>> - * href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986</a>, section
>>> + * href="http://www.ietf.org/html/rfc3986.txt">RFC 3986</a>, section
>>>    * 3.3.
>>>    *
>>>    * <p>The file creation methods take a variable number of 
>>> arguments to
>>> --- 
>>> old/src/java.compiler/share/classes/javax/annotation/processing/Processor.java 
>>> 2019-01-07 22:32:33.940000000 -0800
>>> +++ 
>>> new/src/java.compiler/share/classes/javax/annotation/processing/Processor.java 
>>> 2019-01-07 22:32:33.748000000 -0800
>>> @@ -59,7 +59,7 @@
>>>    * constructor of the processor class.
>>>    *
>>>    * <li>Next, the tool calls the {@link #init init} method with
>>> - * an appropriate {@code ProcessingEnvironment}.
>>> + * an appropriate {@link ProcessingEnvironment}.
>>>    *
>>>    * <li>Afterwards, the tool calls {@link #getSupportedAnnotationTypes
>>>    * getSupportedAnnotationTypes}, {@link #getSupportedOptions
>>> --- 
>>> old/src/java.compiler/share/classes/javax/lang/model/element/ModuleElement.java 
>>> 2019-01-07 22:32:34.520000000 -0800
>>> +++ 
>>> new/src/java.compiler/share/classes/javax/lang/model/element/ModuleElement.java 
>>> 2019-01-07 22:32:34.328000000 -0800
>>> @@ -317,7 +317,7 @@
>>>
>>>           /**
>>>            * Returns the specific modules to which the package is 
>>> being exported,
>>> -         * or null, if the package is exported to all modules which
>>> +         * or {@code null}, if the package is exported to all 
>>> modules which
>>>            * have readability to this module.
>>>            * @return the specific modules to which the package is 
>>> being exported
>>>            */
>>> @@ -339,7 +339,7 @@
>>>
>>>           /**
>>>            * Returns the specific modules to which the package is 
>>> being open
>>> -         * or null, if the package is open all modules which
>>> +         * or {@code null}, if the package is open all modules which
>>>            * have readability to this module.
>>>            * @return the specific modules to which the package is 
>>> being opened
>>>            */
>>> --- 
>>> old/src/java.compiler/share/classes/javax/lang/model/util/Elements.java 
>>> 2019-01-07 22:32:34.928000000 -0800
>>> +++ 
>>> new/src/java.compiler/share/classes/javax/lang/model/util/Elements.java 
>>> 2019-01-07 22:32:34.732000000 -0800
>>> @@ -511,6 +511,7 @@
>>>        * @param hidden  the second element
>>>        * @return {@code true} if and only if the first element hides
>>>        *          the second
>>> +     * @jls 8.4.8 Inheritance, Overriding, and Hiding
>>>        */
>>>       boolean hides(Element hider, Element hidden);
>>>
>>>
>



More information about the compiler-dev mailing list