ノート
[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#
-
jdk/src/java.base/share/classes/javax/crypto/Cipher.java at 0737a5625269773dcf70b95f8b8ac90b3b6cc444 · openjdk/jdkJDK main-line development https://openjdk.org/projects/jdk - jdk/src/java.base/share/classes/javax/crypto/Cipher.java at 0737a5625269773dcf70b95f8b8ac90b3b6cc444 · openjdk/jdkGitHub
↩
-
8357880: Code formatting typo in Cipher.getMaxAllowedParameterSpec by PeyaPeyaPeyang · Pull Request #28145 · openjdk/jdkFix JavaDoc typos in Cipher class: correct {code ...} to {@code ...} in the constructor and getMaxAllowedParameterSpec() Progress Change must be properly reviewed (1 review requir…GitHub
↩
-
8357880: Code formatting typo in Cipher.getMaxAllowedParameterSpec by PeyaPeyaPeyang · Pull Request #28145 · openjdk/jdkJDK main-line development https://openjdk.org/projects/jdk - 8357880: Code formatting typo in Cipher.getMaxAllowedParameterSpec by PeyaPeyaPeyang · Pull Request #28145 · openjdk/j…GitHub
↩
-
8357880: Fix typos in Javadoc for Cipher class · openjdk/jdk@408ea85JDK main-line development https://openjdk.org/projects/jdk - 8357880: Fix typos in Javadoc for Cipher class · openjdk/jdk@408ea85GitHub
↩
-
8357880: Code formatting typo in Cipher.getMaxAllowedParameterSpec · openjdk/jdk@d5831edJDK main-line development https://openjdk.org/projects/jdk - 8357880: Code formatting typo in Cipher.getMaxAllowedParameterSpec · openjdk/jdk@d5831edGitHub
↩