RFR: 8252537: Updated @exception with @throws
Roger Riggs
rriggs at openjdk.java.net
Tue Sep 15 19:21:37 UTC 2020
On Tue, 15 Sep 2020 19:13:55 GMT, Vipin Sharma <vsharma at openjdk.org> wrote:
>> I've only looked at the management files. They look good in general.
>>
>> src/java.management/share/classes/java/lang/management/ClassLoadingMXBean.java
>>
>> 108 * @throws java.lang.SecurityException if a security manager
>> 109 * exists and the caller does not have
>> 110 * ManagementPermission("control").
>>
>>
>> src/java.management/share/classes/java/lang/management/MemoryMXBean.java
>>
>> 286 * @throws java.lang.SecurityException if a security manager
>> 287 * exists and the caller does not have
>> 288 * ManagementPermission("control").
>>
>> Could you, please, fix the indentation?
>
> @RogerRiggs I understand your point and will update PR with correct indentation.
> But I think adding 3 spaces after throws may not be right for all cases.
> For example when
> 1. Another tag in same method is using only 1 space.
> 2. In some cases (e.g. free method of Blob.java) we had a mix of throws and exception in the same method both with one
> space after. Here after adding 3 spaces throws tags will have the different number of spaces and indentation will not
> be same as before. I will update PR to make sure the indentation looks same as before and there is no change in
> javadoc. Please tell me in case my understnding is not correct here.
HI Vipin,
Correct, a better description is "fix the indentation".
I mnetioned 3 because that was the difference in length between
"exception" and "throws".
Thanks for the followup, Roger
On 9/15/20 3:14 PM, Vipin Sharma wrote:
>
> @RogerRiggs
> <https://urldefense.com/v3/__https://github.com/RogerRiggs__;!!GqivPVa7Brio!IQp3U9OccSzrjwI7nzJl491MGc8URG355lsnpdvFTIOGQcgmRGlpC-Kpz3kh64J6$>
> I understand your point and will update PR with correct indentation.
> But I think adding 3 spaces after throws may not be right for all cases.
> For example when
>
> 1. Another tag in same method is using only 1 space.
> 2. In some cases (e.g. free method of Blob.java) we had a mix of
> throws and exception in the same method both with one space after.
> Here after adding 3 spaces throws tags will have the different
> number of spaces and indentation will not be same as before.
>
> I will update PR to make sure the indentation looks same as before and
> there is no change in javadoc.
> Please tell me in case my understnding is not correct here.
>
> —
> You are receiving this because you were mentioned.
> Reply to this email directly, view it on GitHub
> <https://urldefense.com/v3/__https://github.com/openjdk/jdk/pull/95*issuecomment-692922280__;Iw!!GqivPVa7Brio!IQp3U9OccSzrjwI7nzJl491MGc8URG355lsnpdvFTIOGQcgmRGlpC-Kpz78EqgGt$>,
> or unsubscribe
> <https://urldefense.com/v3/__https://github.com/notifications/unsubscribe-auth/AAIRSVAMITTR62U3YVETCM3SF64IFANCNFSM4RDCQ4MA__;!!GqivPVa7Brio!IQp3U9OccSzrjwI7nzJl491MGc8URG355lsnpdvFTIOGQcgmRGlpC-Kpz1RGWzIm$>.
>
-------------
PR: https://git.openjdk.java.net/jdk/pull/95
More information about the serviceability-dev
mailing list