RFR 8252537: Replace @exception with @throws for core-libs
Vipin Sharma
vipinsharma85 at gmail.com
Fri Sep 4 19:05:03 UTC 2020
Hi Martin,
> On Sep 4, 2020, at 1:14 AM, Martin Buchholz <martinrb at google.com> wrote:
>
> Thanks for doing this!
>
> 15 years ago I considered taking on this task, eventually backing away
> because it was too much work (!). But I made sure most of the classes
> I maintained were using @throws.
>
> When considering this, I thought that tidying the whitespace after
> conversion would be a big part of the task, even though it is
> technically non-essential. Current use of whitespace with @throws is
> inconsistent, as you have seen.
>
In these inconsistencies majority of the cases, we have more than one whitespace after @throws. There are a few cases where we have more than one whitespace character before @throws as well.
I think if we are fixing whitespace inconsistencies of @throws then at the same time we should fix for other tags as well.
Following are occurrences from jdk/src/ for some of the Javadoc tags along with regex used. If you think it is worth fixing I can start it from core-libs.
\*[ ]{1}@throws[ ]{2,}
Occurrences 4191
\*[ ]{1}@param[ ]{2,}
Occurrences 7543
\*[ ]{1}@return[ ]{2,}
Occurrences 3830
\*[ ]{1}@see[ ]{2,}
Occurrences 3886
\*[ ]{1}@since[ ]{2,}
Occurrences 1826
\*[ ]{1}@author[ ]{2,}
Occurrences 1156
\*[ ]{1}@deprecated [ ]{2,}
22 Occurrences
\*[ ]{1}@serial[ ]{2,}
4 Occurrences
\*[ ]{1}@serialData[ ]{2,}
3 Occurrences
\*[ ]{1}@serialField[ ]{2,}
10 Occurrences
\*[ ]{1}@version[ ]{2,}
1 Occurrence
> On Thu, Sep 3, 2020 at 12:34 PM Vipin Sharma <vipinsharma85 at gmail.com> wrote:
>>
>> Hi,
>>
>> Please review and sponsor the fix for replacing @exception with @throws for
>> core-libs.
>>
>> Issue: https://bugs.openjdk.java.net/browse/JDK-8252537
>> Webrev: https://cr.openjdk.java.net/~vsharma/8252537
>>
>> As suggested in the previous discussion
>> <https://mail.openjdk.java.net/pipermail/core-libs-dev/2020-September/068486.html>,
>> this webrev has a consolidated fix for all subtasks of the JDK-8252536
>> <https://bugs.openjdk.java.net/browse/JDK-8252536>.
>> There is no change in the indentation as part of this webrev.
>>
>> Regards,
>> Vipin
Regards,
Vipin
More information about the core-libs-dev
mailing list