RFR [9] 8079478: some docs cleanup for sun.security

alexander stepanov alexander.v.stepanov at oracle.com
Wed May 6 15:54:28 UTC 2015


Hello Max,

Thanks!

 > Is there a handy tool so that we don't make same mistakes later?

tidy tool (http://www.html-tidy.org/ - I guess on Ubuntu it could be 
installed by means of "apt-get install tidy") usually report such "empty 
<p>" warnings - but it checks the resulting HTML files, not the sources 
(so at first the docs should be built by means of javadoc).

Unfortunately it does not recognize erroneous javadoc tags, like 
"@params" or "@returns", only HTML markup issues.

Regards,
Alexander

On 06.05.2015 17:51, Weijun Wang wrote:
> I think they are good, at least for those wrong tags or @params with 
> wrong names. It's always nice to use correct format even if the doc is 
> not published.
>
> You're welcomed to fix other docs in java.security.* or jdk.security.* 
> modules.
>
> Is there a handy tool so that we don't make same mistakes later? I 
> know IntelliJ IDEA will show errors for wrong @params names, but it 
> does not care about useless <p>s.
>
> Thanks
> Max
>
> On 5/6/2015 10:24 PM, alexander stepanov wrote:
>> Hello,
>>
>> Could you please review the following fix
>> http://cr.openjdk.java.net/~avstepan/8079478/webrev.00/
>>
>> for
>> https://bugs.openjdk.java.net/browse/JDK-8079478
>>
>> Just some doc fixes.
>>
>> Please note: not sure if these docs should be fixed at all because in
>> the new modular system these packages should (probably) not be visible.
>>
>> So please let me know if the fix is useless.
>>
>> Thanks,
>> Alexander
>>



More information about the security-dev mailing list