Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Javadoc sections misaligned #1346

Closed
iloveeclipse opened this issue Apr 22, 2024 · 3 comments · Fixed by #1351
Closed

Javadoc sections misaligned #1346

iloveeclipse opened this issue Apr 22, 2024 · 3 comments · Fixed by #1351
Assignees
Labels
bug Something isn't working regression Regression defect
Milestone

Comments

@iloveeclipse
Copy link
Member

iloveeclipse commented Apr 22, 2024

Stumbled while looking at this code java doc: FileSystems.newFileSystem((URI)null, null, null);
Javadoc looks like on 4.30:

image

Javadoc looks like on 4.32:

image

Note the missing indentation of "Parameters", "Returns" and "Throws" section headers - this makes reading complex javadoc harder as it should be.

The section headers should be aligned on left side, not on same column as the following content.

image

Also other headers ("Since", "See Also") are now misaligned, like on java.util.regex.Pattern.splitAsStream(CharSequence):

image

I assume all section headers are misaligned now :-(

This is a regression from #941

@iloveeclipse iloveeclipse added bug Something isn't working regression Regression defect labels Apr 22, 2024
@iloveeclipse iloveeclipse added this to the 4.32 M2 milestone Apr 22, 2024
@iloveeclipse
Copy link
Member Author

@RedeemerSK : could you please check this one?

@RedeemerSK
Copy link
Contributor

@iloveeclipse seems like it was broken in 4.31 already. Commit that broke it: cbc03c2

(I assume it's related to changes in JavadocContentAccess2.java )

Changing from using
<dl> + <dd>
HTML elements to
<ul> + <li>

iloveeclipse added a commit to iloveeclipse/eclipse.jdt.ui that referenced this issue Apr 23, 2024
Regression from cbc03c2

The code moved from JavadocContentAccess2 to CoreJavadocAccessImpl
changed dt/dd tags to ul/li tag pairs, and that broke javadoc alignment.

This commit restores original tag pairs used for javadoc formatting.

Fixes eclipse-jdt#1346
@iloveeclipse
Copy link
Member Author

@RedeemerSK : many thanks. I've created #1351 for the fix.

iloveeclipse added a commit that referenced this issue Apr 23, 2024
Regression from cbc03c2

The code moved from JavadocContentAccess2 to CoreJavadocAccessImpl
changed dt/dd tags to ul/li tag pairs, and that broke javadoc alignment.

This commit restores original tag pairs used for javadoc formatting.

Fixes #1346
@iloveeclipse iloveeclipse self-assigned this Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working regression Regression defect
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants