FP on java:S1176 with Markdown JavaDoc

I have a Java 23 project where I’m using JEP 467: Markdown Documentation Comments e.g.

/// The [Foo] class.
public class Foo {}

And on SonarQube Cloud I get false-positive issues for “Public types, methods and fields (API) should be documented with Javadoc” (java:S1176) even though the types/methods are documented. Setting sonar.java.source=23 didn’t make any difference.

Hi there,

we recently introduced support for Java 23, including many fixes to rules which interacted with Javadoc comments. This is the PR.

This specific case you reported should be fixed with the next release of the analyzer.

Thanks for the report!

1 Like

Awesome to hear, thanks! Do I need to perform some action in SonarCloud to enable this, or once released the issues will disappear on next analysis?

Hi,

After this goes to production, the next analysis should stop finding the issues. They’ll be moved to status Closed automatically.

 
:slight_smile:
Ann

1 Like