Fix for Javadoc errors in java.base

Jonathan Gibbons jonathan.gibbons at oracle.com
Thu Aug 13 17:21:49 UTC 2020


On 8/13/20 10:13 AM, Sean Mullan wrote:
> On 8/13/20 11:05 AM, Julia Boes wrote:
>> Hi Vipin,
>>
>> Thanks for providing this fix, I'm happy to sponsor your change. To 
>> complete the review, we still need someone to green light the 
>> remaining changes below. I'm looping in net-dev and security-dev to 
>> have a look.
>>
>> Bug: https://bugs.openjdk.java.net/browse/JDK-8251542
>>
>> Webrev: http://cr.openjdk.java.net/~jboes/webrevs/8251542/webrev/
>>
>> Once the review is completed, please provide me with a patch that 
>> includes a changeset comment as described here: 
>> https://openjdk.java.net/guide/producingChangeset.html
>>
>> If you have any questions, let me know.
>>
>> Cheers,
>>
>> Julia
>>
>>> --- 
>>> old/src/java.base/share/classes/com/sun/crypto/provider/DHPrivateKey.java
>>> 2020-07-25 23:46:21.233726447 +0530
>>> +++ 
>>> new/src/java.base/share/classes/com/sun/crypto/provider/DHPrivateKey.java
>>> 2020-07-25 23:46:20.721720857 +0530
>>> @@ -96,8 +96,6 @@
>>>        * @param p the prime modulus
>>>        * @param g the base generator
>>>        * @param l the private-value length
>>> -     *
>>> -     * @exception InvalidKeyException if the key cannot be encoded
>
> This should actually remain, but it should be ProviderException which 
> is a RuntimeException. See the other DHPrivateKey ctor as that 
> specifies it correctly.
>
> --Sean


I note the use of `@exception`, as compared to `@throws`, which is more 
common.

Stats:
`@exception` 7322 occurrences
`@throws` 21173 occurrences

That's probably too many `@exception` to clean up. :-(

-- Jon



More information about the security-dev mailing list