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

JDK 13+ : Headings should start with h2 and h4 #208

Open
yeikel opened this issue Apr 14, 2023 · 0 comments
Open

JDK 13+ : Headings should start with h2 and h4 #208

yeikel opened this issue Apr 14, 2023 · 0 comments
Labels
recipe Recipe requested

Comments

@yeikel
Copy link
Contributor

yeikel commented Apr 14, 2023

Headings in documentation comments for all modules, packages and types (including nested types) should begin at <h2>.
Headings in members should begin at <h4>.

Currently, this leads to the following failure:

MavenReportException: Error while generating Javadoc: 
[ERROR] Exit code: 1
[ERROR] /MyClass.java:24: error: unexpected heading used: <H1>, compared to implicit preceding heading: <H1>
[ERROR]  * <h1>My heading</h1>

Changing it to <h2> is enough to fix it

See https://bugs.openjdk.org/browse/JDK-8220379

@yeikel yeikel changed the title JDK 13+ : Headings should start with h2 JDK 13+ : Headings should start with h2 and h4 Apr 14, 2023
@sambsnyd sambsnyd added the recipe Recipe requested label Apr 14, 2023
@sambsnyd sambsnyd moved this to Recipes Wanted in OpenRewrite Apr 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
recipe Recipe requested
Projects
Status: Recipes Wanted
Development

No branches or pull requests

2 participants