-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
JavadocType: False negative for unknown tag with no description #14573
Comments
Example showing that violation is produced as expected if the unknown tag is with the description. (same config is used) Test.java /**
* @val well well well, how the turntables
*/
class Test {} CLI: |
sktpy
changed the title
False negative for JavadocType
JavadocType: False negative for unknown tag with no description
Mar 1, 2024
Resolution on #14618 is required so that I can decide on how to proceed with this issue. |
strkkk
added a commit
to strkkk/checkstyle
that referenced
this issue
May 17, 2024
strkkk
added a commit
to strkkk/checkstyle
that referenced
this issue
May 17, 2024
strkkk
added a commit
to strkkk/checkstyle
that referenced
this issue
May 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
(Documentation)
config.xml
Test.java
Current CLI:
Expected:
Explanation:
val
is an unknown tag (allowUnknownTags by default is false), and hence should produce a violation.Attention note from maintainers:
checkstyle/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocTypeCheck.java
Lines 149 to 150 in 72cf172
this Check is not AST based, so fix might be not trivial. We can accept fix only if it is simple and does not cause more regressions or false positives. Ideally we should reimplement this Check to be ast based, example:
checkstyle/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AtclauseOrderCheck.java
Line 110 in 72cf172
The text was updated successfully, but these errors were encountered: