[9] RFR: 8130753: Sync-up javadoc changes in jax-ws area - includes JAX-B API, JAX-WS API, SAAJ-API
Joseph D. Darcy
joe.darcy at oracle.com
Fri Jul 10 23:08:35 UTC 2015
Hello,
Note that as part of JEP 212, large parts of the sources in the jdk are
now compiled with both lint and doclint checks enabled. For technical
reasons explained in
"FYI, coming soon: doclint checking of references"
http://mail.openjdk.java.net/pipermail/jdk9-dev/2015-June/002343.html
the "reference" doclint category will be enforced in the main *javadoc*
build rather than the javac build of the sources. Therefore, javadoc
changes should include a docs build to verify the docs build still works
(which is a good, if not commonly done, practice anyway).
Thanks,
-Joe
On 7/9/2015 3:36 AM, Miroslav Kos wrote:
> Hi again,
> thanks for valuable feedback - I missed those before. Second version
> of a patch:
> http://cr.openjdk.java.net/~mkos/8130753/jaxws.02/
>
> issues addressed:
>
> * <tt> : not backporting correctly changes done in jdk repo, will
> fix in standalone repos
> * <pre>/ {@code : added <pre> again, in two cases used <pre><code>
> * copyright years : fixed
>
>
> Otherwise I don't use -Xdoclint but I generate javadoc so I see
> warnings -
> before patch:
> 10 errors
> 78 warnings
>
> after patch:
> 78 warnings
>
> I also used specdiff to doblecheck that there are no differences in
> output javadoc - those are classes defined by JSRs, so no changes are
> wanted without MR. Only 2 changes found (typos). Additional issues
> (warnings) would be addressed during MRs.
>
> Thanks
> Miran
>
>
> On 08/07/15 18:36, joe darcy wrote:
>> Hi Miroslav,
>>
>> At least some of the changes in the patch are going in the wrong
>> direction. There are many instances toward the start of the patch
>> where {@code Foo} is listed as being replaced by <tt>Foo</tt>, but
>> {@code Foo} is what we want to use now.
>>
>> Are you running doclint over Java source or in a docs build to verify
>> the changes?
>>
>> Thanks,
>>
>> -Joe
>>
>> On 7/8/2015 5:29 AM, Miroslav Kos wrote:
>>> Hi everybody,
>>> I'd like to ask for review for following issue:
>>>
>>> JBS: 8130753: Sync-up javadoc changes in jax-ws area - includes
>>> JAX-B API, JAX-WS API, SAAJ-API
>>> webrev: http://cr.openjdk.java.net/~mkos/8130753/jaxws.01/
>>>
>>> It addresses all the javadoc errors in all 3 JSRs: SAAJ, JAX-B and
>>> JAX-WS and it is also syncup with standalone repos. This clean-up
>>> had to be done in order to proceed with changes necessary for Jigsaw
>>> (specifically SAAJ API and possibly JAX-WS).
>>>
>>> Thanks
>>> Miran
>>>
>>>
>>
>
More information about the core-libs-dev
mailing list