RFR: 8290775: Some doc errors in DerOutputStream.java [v3]

[Xue-Lei Andrew Fan]

On Fri, 22 Jul 2022 14:56:34 GMT, jquanC <duke at openjdk.org> wrote:

>> There are some doc errors in sun.security.util.DerOutputStream, like the followings,
>> 
>> 
>> /**
>>  * Private helper routine for writing DER encoded string values.
>>  * @param s the string to write
>>  * @param stringTag one of the DER string tags that indicate which
>>  * encoding should be used to write the string out.
>>  * @param enc the name of the encoder that should be used corresponding
>>  * to the above tag.
>>  */
>> private void writeString(String s, byte stringTag, Charset charset) throws IOException
>> 
>> The parameter is charset, but not enc.
>> 
>> 
>> /**
>>  * Marshals a DER integer on the output stream.
>>  *
>>  * @param i the integer in bytes, equivalent to BigInteger::toByteArray.
>>  */
>> public void putInteger(byte[] buf) throws IOException {
>> 
>> The parameter is buf, but not i.
>
> jquanC has updated the pull request incrementally with one additional commit since the last revision:
> 
>   8290775: Some doc errors in DerOutputStream.java  Update:correct the tense problem of expression

src/java.base/share/classes/sun/security/util/DerOutputStream.java line 464:

> 462:      * @param stringTag one of the DER string tags that indicate which
> 463:      * encoding should be used to write the string out.
> 464:      * @param charset the charset should be used corresponding to the

I may suggest to add 'that' back.  Without it, the meaning of the sentence may be different.

... the charset should be used corresponding to the above tag.
vs
... the charset **that** should be used corresponding to the above tag.

-------------

PR: https://git.openjdk.org/jdk/pull/9585