8000269: Cleanup javadoc warnings

Alan Bateman Alan.Bateman at oracle.com
Sun Sep 30 10:54:20 UTC 2012


On 29/09/2012 22:54, Ulf Zibis wrote:
> :
>
>>
>>> - in lines 702, 825 indentation should be 8.
>>> - in line 826 I guess you wanted to move the curly brace to line 825
>> Curly Brace: I think that's the style we use when the method 
>> signature spreads across multiple lines.
>
> To me this is an ugly break in style.
When a method signature is long or a method declares several checked 
exceptions that cause it to slip over into more than one line then there 
are different conventions and we don't have consistently in the JDK. 
Some people prefer to put the opening brace onto the next line, others 
prefer put the opening brace at the end of the line. It's a matter of 
taste, I think prefer the former, if only because I often find myself 
looking at unfamiliar code with lots of parameters and exceptions and I 
want to quickly distinguish the method signatures from the method body. 
In any case, I don't think it's worth spending time on this as this 
change is about fixing up javadoc warnings and cross references, the 
minor changes to the formatting of the permission classes are just 
drive-by clean-ups because the formatting of those classes is so odd. 
You are right that more could be done on formatting on the classes that 
are touched in this webrev, like L702 of java.io.FilePermission.

-Alan.



More information about the core-libs-dev mailing list