-
Bug
-
Resolution: Fixed
-
P3
-
17, 21, 22, 23
-
b14
-
generic
-
generic
Issue | Fix Version | Assignee | Priority | Status | Resolution | Resolved In Build |
---|---|---|---|---|---|---|
JDK-8334612 | 21.0.5-oracle | Johny Jose | P3 | Resolved | Fixed | b04 |
JDK-8337253 | 21.0.5 | Matthias Baesken | P3 | Resolved | Fixed | b01 |
JDK-8334613 | 17.0.13-oracle | Johny Jose | P3 | Resolved | Fixed | b04 |
JDK-8337346 | 17.0.13 | Matthias Baesken | P3 | Resolved | Fixed | b01 |
Java 21
A DESCRIPTION OF THE PROBLEM :
The issue is occurring because JDK 21 constructs the "Method Summary" in HTML without utilizing <td> and <tr> tags as it did in Java 8.
If there are <i>, <b>, or any other tags in the first line of the JavaDocs, then the entire JavaDocs becomes misaligned.
```HTML
/**
* <p>
* <i> <b>This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List
* API is subject to the Beta Service Participation terms of the <a
* href="https://aws.amazon.com/service-terms/">Amazon Web Services Service Terms</a> (Section 1.10).</b> </i>
* </p>
* <p>
*/
```
- Note that the above JavaDoc is correct since it has both opening and closing <i>, but they are on different lines.
- However, when Java 21 generates JavaDocs HTML for "Method Summary," it only selects the first line.
- It selects <i> without </i>, which is three lines down. Due to the absence of the closing </i> tag in the table, the entire JavaDoc HTML becomes distorted.
- To see an example, refer to https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/pricing/PricingClient.html#describeServices(software.amazon.awssdk.services.pricing.model.DescribeServicesRequest and observe "This feature is in preview release and is subject to change." in the Method Summary.
A similar JavaDoc with the same content generated from Java 8 can be observed functioning correctly at https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/pricing/AWSPricing.html.
REGRESSION : Last worked in version 8
STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
Try generating a Java doc with the first line as below in any API
/**
* <p>
* <i> <b>This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List
* API is subject to the Beta Service Participation terms of the <a
* href="https://aws.amazon.com/service-terms/">Amazon Web Services Service Terms</a> (Section 1.10).</b> </i>
* </p>
* <p>
*/
public void recreateIssue(){
}
EXPECTED VERSUS ACTUAL BEHAVIOR :
EXPECTED -
- The Java Doc generation should generate tables with <td> and <tr> so that any missing closing tags due to its presence in multiple line should not leak.
- Or Java Doc generation should pick the complete line till it gets Java Doc
ACTUAL -
Good case : https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/pricing/AWSPricing.html
---------- BEGIN SOURCE ----------
Generate Java doc with Java 21 for a code with Java Doc as https://github.com/aws/aws-sdk-java/blob/aa74c25a97b185df33a32e0934a463655c71f3a4/aws-java-sdk-pricing/src/main/java/com/amazonaws/services/pricing/AWSPricing.java#L141-L170
---------- END SOURCE ----------
FREQUENCY : always
- backported by
-
JDK-8334612 Unclosed inline tags cause misalignment in summary tables
- Resolved
-
JDK-8334613 Unclosed inline tags cause misalignment in summary tables
- Resolved
-
JDK-8337253 Unclosed inline tags cause misalignment in summary tables
- Resolved
-
JDK-8337346 Unclosed inline tags cause misalignment in summary tables
- Resolved
- links to
-
Commit openjdk/jdk/a6dc4bc2
-
Commit(master) openjdk/jdk17u-dev/5ed58c2f
-
Commit(master) openjdk/jdk21u-dev/cc85abc2
-
Review openjdk/jdk/18154
-
Review(master) openjdk/jdk17u-dev/2746
-
Review(master) openjdk/jdk21u-dev/866