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

Fixed 10 javadoc errors with MicroProfile 6.0 #765

Merged
merged 1 commit into from
Feb 1, 2023

Conversation

steven1046
Copy link
Contributor

These were found while trying to generate MicroProfile 6.0 javadocs. The html was still produced, but some of the links did not work. The code changes will fix the links by changing the syntax in comments for what the javadoc command generates.

@link MetricRegistry.APPLICATION_SCOPE for instance generates just text:
image

This is fixed by changing it to ``@link MetricRegistry#APPLICATION_SCOPE` which generates a link:
image

@eclipse-microprofile-bot
Copy link
Contributor

Can one of the admins verify this patch?

@steven1046
Copy link
Contributor Author

Fixes #764

@Channyboy
Copy link
Contributor

build please

@steven1046
Copy link
Contributor Author

@Channyboy, is there anything i need to do? I followed the instructions at https://github.com/eclipse/microprofile-metrics/blob/master/CONTRIBUTING.adoc.

@Channyboy
Copy link
Contributor

Oh, the build please was just to trigger Jenkins to do a build. Everything looks good!

@Channyboy Channyboy merged commit a60885e into eclipse:master Feb 1, 2023
@steven1046
Copy link
Contributor Author

@Channyboy , thank you for merging! Would this code eventually make it into the release here: https://github.com/eclipse/microprofile-metrics/releases/tag/5.0.0?

@Channyboy
Copy link
Contributor

Unfortunately, the 5.0.0 release is already out. But we are planning a 5.0.1 release soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants