ノート

[BUG] 8357880: Code formatting typo in Cipher.getMaxAllowedParameterSpec

Cipher クラスの JavaDoc に残っていた code タグの typo を修正しました。

概要#

 javax.crypto.Cipher の​ JavaDoc では,​インライン・​コードを​表すために​ {@code ...} を​使います。​ ところが,​一部の​コメントでは​ @ が​抜けており,{code ...} と​いう​形に​なっていました1

 対象と​なったのは,NullCipher から​内部的に​呼び出される​コンストラクタの​説明と,getMaxAllowedParameterSpec の​説明です。​ この​ typo が​あると,​JavaDoc 上で​コードと​して​整形されず,​そのまま​ {code Cipher} や​ {code AlgorithmParameterSpec} と​表示されてしまいます。

 今回の​修正では,​以下のように​ @ を​補って,​正しい​ JavaDoc の​インライン・タグへ​修正しました2

-     * Creates a {code Cipher} object. Called internally by {code NullCipher}.
+     * Creates a {@code Cipher} object. Called internally by {@code NullCipher}.
-     * Returns an {code AlgorithmParameterSpec} object which contains
+     * Returns an {@code AlgorithmParameterSpec} object which contains
-     * @return an {code AlgorithmParameterSpec} object which holds the maximum
+     * @return an {@code AlgorithmParameterSpec} object which holds the maximum

 コードの​挙動には​影響しない,​ドキュメント上の​ typo 修正です。

2025/11/05 JBS で​発見#

 本バグを​ JBS で​発見し,​対象箇所を​確認しました。​ Cipher.java の​ JavaDoc 内で,{@code ...} と​書くべき箇所が​ {code ...} に​なっていた​ため,​これを​修正する​ PR を​作成しました3

 修正箇所は​ 3 箇所で,​変更対象ファイルは​ src/java.base/share/classes/javax/crypto/Cipher.java のみです。​ Pull Request Bot に​よる​事前チェックも​通過し,security ラベルが​付与されました。

2025/11/05 レビュー#

 Francesco Andreuzzi氏と​ Sean Mullan氏に​レビューを​いただき,​Approve されました。

 レビュー後,/integrate を​行い,408ea854 の​変更が​スポンサー待ちに​なりました。

2025/11/05 統合#

 Weijun Wang氏に​ /sponsor を​していただき,d5831ed5 と​して​ JDK へ​統合されました。


Footnotes#