Sonarqube - documented API configuration

Question

I use sonarqube 4.3.2 for java project. Is there any way to configure sonarqube settings when checking javadoc for public API? Right now all uncodumented public classes/methods/constructors are checked for javadoc. I would like to skip checking on default constructors and setters/getters.

benzonico · Accepted Answer · 2014-08-21 11:50:50Z

1

By default undocumentedAPI check should skip setters and getters.

There are unfortunately no configuration available for this rule, so only way is to deactivate it alltogether or mark issues as false positive.

answered Aug 21, 2014 at 11:50

benzonico

10.9k5 gold badges46 silver badges51 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Piotr Chowaniec Over a year ago

In my project setters and getters are counted as undocumented API. And I think undocumented API and issues are separated. I have a class without any issue but with undocumented API, and can't see any way to mark this as false positive.

benzonico Over a year ago

Sorry I mixed up metric and issue. But nonetheless, accessors should be excluded from this metric.

Collectives™ on Stack Overflow

Sonarqube - documented API configuration

1 Answer 1

2 Comments

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Related