-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
WriteTag reports violation with confusing message when there is no javadoc #11584
Comments
It is expected that check will not report violation if there is no javadoc |
theWolf1198
added a commit
to theWolf1198/checkstyle
that referenced
this issue
Jun 6, 2022
…iolation, added two new unit test cases
strkkk
added a commit
to strkkk/checkstyle
that referenced
this issue
Mar 11, 2023
…eporting null tag
strkkk
added a commit
to strkkk/checkstyle
that referenced
this issue
Mar 11, 2023
…eporting null tag
strkkk
added a commit
to strkkk/checkstyle
that referenced
this issue
Mar 11, 2023
…eporting null tag
strkkk
added a commit
to strkkk/checkstyle
that referenced
this issue
Mar 11, 2023
…eporting null tag
strkkk
added a commit
to strkkk/checkstyle
that referenced
this issue
Apr 15, 2023
…eporting null tag
strkkk
added a commit
to strkkk/checkstyle
that referenced
this issue
Apr 15, 2023
…eporting null tag
romani
pushed a commit
to strkkk/checkstyle
that referenced
this issue
Apr 19, 2023
…eporting null tag
strkkk
added a commit
to strkkk/checkstyle
that referenced
this issue
Apr 21, 2023
…iolation on missing javadoc
yes, please takes , there is almost done PR, please reuse that code. That PR is abandoned. |
aayushRedHat
added a commit
to aayushRedHat/checkstyle
that referenced
this issue
Dec 18, 2023
…sage when there is no javadoc
MohanadKh03
added a commit
to MohanadKh03/checkstyle
that referenced
this issue
Nov 1, 2024
…sage when there is no javadoc
MohanadKh03
added a commit
to MohanadKh03/checkstyle
that referenced
this issue
Nov 9, 2024
…sage when there is no javadoc
MohanadKh03
added a commit
to MohanadKh03/checkstyle
that referenced
this issue
Nov 9, 2024
…sage when there is no javadoc
MohanadKh03
added a commit
to MohanadKh03/checkstyle
that referenced
this issue
Nov 9, 2024
…sage when there is no javadoc
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
https://checkstyle.org/config_javadoc.html#WriteTag
Expected: no violation, since there is no javadoc.
Also note confusing violation message ("null" tag).
For javadoc presence there are other checks. And docs mention that with default config it does nothing, but it reports weird message instead.
P.S. Checkstyle has
WriteTag
with default config -checkstyle/config/checkstyle_checks.xml
Line 653 in 4ad2536
Breaking behavior compatibility migration notes:
No configuration breaking changes. Breaking compatibility is only in behavior - so it is defect/bug fix.
after fix and release (10.21.0) Check will not report violations on missed Javadocs.
To archive behavior as before, users should start using InvalidJavadocPosition, MissingJavadocMethod , MissingJavadocPackage , MissingJavadocType to let Checkstyle demand javadoc first and when WriteTag will demand required tag in existing javadoc
The text was updated successfully, but these errors were encountered: