RFR: JDK-8284851 Update javax.crypto files to use proper javadoc for mentioned classes [v2]

Mark Powers duke at openjdk.org
Tue Jun 28 21:15:01 UTC 2022


On Tue, 28 Jun 2022 20:33:17 GMT, Valerie Peng <valeriep at openjdk.org> wrote:

>> src/java.base/share/classes/javax/crypto/Cipher.java line 184:
>> 
>>> 182: 
>>> 183:     /**
>>> 184:      * Constant used to initialize {@code Cipher} to encryption mode.
>> 
>> If it's lower case, we normally just leave it? Not sure what is the criteria for changing this. Is it because these are public static constants, so you prefer more formatting? But then, some have "object" following the `{@code Cipher}`, and some aren't which looks a bit inconsistent.
>
> Personally, I'd against making this change, i.e. changing all "cipher" occurrences to "{@code Cipher}". Can we just stick to fixing what's broken?

In this case the sentence was about initializing a cipher object, so I changed it to `{@code Cipher}`. If a sentence says "cipher block size" then I tried to leave it alone because it's referring to an algorithm rather than a class or object. I could add "object" after `{@code Cipher} `if it's not present. That would make it more consistent.

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

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


More information about the security-dev mailing list