Closed Siedlerchr closed 1 year ago
@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. I will try to refine it
As a developer, I open IntelliJ and start the javadoc generation to have "nice" documentation.
Especially the empty comment at ThreeWayMergeCell can be easily fixed:
Just remove the comment.
Each "broken" link should be followed by Ctrl+Left Mouse. For all links I checked, these exists
Information about {@link}
: It is used inside texts. @see
is an own block. See also https://stackoverflow.com/a/10097249/873282.
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 https://github.com/JabRef/jabref/pull/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 https://github.com/koppor/jabref/issues/475#issuecomment-1469679681 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 https://github.com/JabRef/jabref/pull/9911. Maybe, this helps to fix the other ones?
Excerpt from the javadoc generation: