-
Notifications
You must be signed in to change notification settings - Fork 15
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
Fix javadoc errors and warnings #475
Fix javadoc errors and warnings #475
Comments
@Siedlerchr please provide better explanation of this issue, otherwise this might not be a "good first issue", in particular "how to trigger the error" and "how to use "javadoc" |
This is a code quality issue. Not really important. |
As a developer, I open IntelliJ and start the javadoc generation to have "nice" documentation.
Fixing empty commentsEspecially the empty comment at ThreeWayMergeCell can be easily fixed: Just remove the comment. Fixing not found linksEach "broken" link should be followed by Ctrl+Left Mouse. For all links I checked, these exists Information about Suggestion: In case the link can be followed in IntelliJ, just keep it. We should then follow up https://bugs.openjdk.org/browse/JDK-8224266 and check whether there is still an issue in warnings vs. errors in link reporting in the javadoc module of JDK - or if our gradle installation does something wrong. Starting point: /build.gradle#L409 |
Not all errors are fixed at JabRef#9701. Therefore reopened. |
Hi @koppor, it appears javadoc doesn't generate warnings for empty comments anymore (?), I have searched the code base and I only find one empty comment (See this). Is this how we suppose to fix it? All of the warnings related to "no comments" listed in the original issue descriptions are no longer there. |
I described at #475 (comment) how to reproduce. Think, we cannot do anything about "reference not found". In IntelliJ, I can follow each link. Excerpt from current error output: What you need to do is to double cleack an error and think of how to fix it. I fixed half of it at JabRef#9911. Maybe, this helps to fix the other ones? |
…the javadoc check (#9986)
Excerpt from the javadoc generation:
The text was updated successfully, but these errors were encountered: