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

Weijun Wang weijun at openjdk.org
Fri Jul 22 17:42:22 UTC 2022


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

>> 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.
>
> Thanks again for all the above suggestions sincerely!
> To avoid adding your troubles, I should end up using the following expression:
> 
> the charset that should be used corresponding to the above tag.
> 
> I'm trying to understand the difference between the two.
> The first sentence may be understood as "the process of using charset" according to the above tag.
> The second sentence(use that) can better express "the choice of charset" needs to be based on the above tag.
> Is this correct?

A spec for an argument should be a noun. You can add attributes to describe it in more detail, which can be an adjective, or even a clause. This is what's shown in the 2nd line (I cannot call it a sentence because it's just a noun with an attributive clause). On the other hand, the 1st is a full sentence and it's not what we need here.

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

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



More information about the security-dev mailing list