Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
JavadocUtil doesn't recognize Javadocs in certain places #6516
While looking into #5411 and verifying the statement I made:
I made a bare bones check to verify we recognize all valid javadoc placements.
I expected no violations from this check on Checkstyle's own sources but I get the following:
It looks like currently Checkstyle doesn't work with javadocs on methods with no modifiers and returns an array.
You can also see an example with:
There should be 2 violations as both are methods with the same javadoc.
I am going to run regression to see if there are any other cases.
Let me know if we should open another issue to add this check to Checkstyle. It is pretty simple.
These are other false positives that I have seen so far:
I reviewed almost all the violations and I didn't see anymore false positives.