RFR: 8290775: Some doc errors in DerOutputStream.java

[Xue-Lei Andrew Fan]

On Fri, 22 Jul 2022 01:43:06 GMT, jquanC <duke at openjdk.org> wrote:

> On the second point, I have some doubts. 1) Here don't need to add ***@***.*** charset" because it's clear to everyone? ***@***.*** enc" does not seem to be used in the method. Shouldn't it be deleted?

Sorry for the confusing.

I think it is fine to update the "param enc" to "param charset", but it may be not necessary to update the parameter description.  With "parameter description", I refer to this part, "the name of the encoder that should be used corresponding to the above tag". 

The parameter description may be still confusing to someone, as the 'the name of the encoder' is not well-defined here.  Maybe, it could be simplified as "the charset that ..."


Here is the proposed update:

-     * @param enc the name of the encoder that should be used corresponding
-    * to the above tag.
+    * @param charset the specified character set encodes a string into a
+    * sequence of bytes using


I may use an update like :

-     * @param enc the name of the encoder that should be used corresponding
-    * to the above tag.
+    * @param charset the charset that is should used corresponding to the
+    * above tag.

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

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