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.

Sign up for GitHub

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

Jump to bottom

Update Javadoc for Java 9+ if needed #14

Open
basil opened this issue Aug 18, 2023 · 1 comment
Open

Update Javadoc for Java 9+ if needed #14

basil opened this issue Aug 18, 2023 · 1 comment
Labels
recipe Requests for new automated code changes

Comments

@basil
Copy link
Contributor

basil commented Aug 18, 2023

A common problem when modernizing plugins is that generating Javadoc (which only happens when running with mvn clean verify -Pjenkins-release or mvn clean verify -Dset.changelist) fails on Java9+ with error: tag not supported in the generated HTML version: tt if there are any <tt> tags in the Java code (for example, in cvs-plugin as of jenkinsci/cvs-plugin@26e82b2). The solution in these cases is to replace <tt>foo</tt> with {@code foo}, but this is quite tedious.
@basil basil mentioned this issue Aug 18, 2023
Open
@basil basil changed the title Update Javadocs for Java 9+ Update Javadoc for Java 9+ if needed Aug 18, 2023
@timtebeek timtebeek moved this to Recipes Wanted in OpenRewrite Aug 18, 2023
@timtebeek timtebeek added the recipe Requests for new automated code changes label Aug 18, 2023
@basil
Copy link
Contributor Author

basil commented Aug 18, 2023

There is nothing specific to Jenkins about this either, but we do see this a lot in older Jenkins plugins.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
recipe Requests for new automated code changes
Projects
OpenRewrite
Status: Recipes Wanted
Milestone
No milestone
Development

No branches or pull requests
2 participants
@basil @timtebeek