Ignore missing documentation if superclass has documentation

Question

Is there any way to tell SonarQube not to count an overriding method into the public documented api statistics if the overridden method is documented? SonarQube finds many methods lacking annotation due to the case below.

I know there is an annotation to ignore certain rules of SonarQube, however we don't want to add code to our project in order to satisfy SonarQube.

I can't see the picture but is the overriding method correctly annotated `@Override`? — Tunaki, Dec 03 '15 at 15:57
I will verify that on Monday. The picture shows a graph from SonarQube with Issues and Public documented API, not super necessary. — michaelbahr, Dec 04 '15 at 12:02

score 3 · Accepted Answer · answered Dec 03 '15 at 15:59

3

You could use inherit doc.

/**
 * {@inheritDoc}
 */
@Override

answered Dec 03 '15 at 15:59

StackFlowed

6,664
1
29
45

1

During furthher investigation I stumbled upon an IntelliJ IDEA Inspection rule saying: "Reports any Javadoc comments which contain only the {@inheritDoc} tag. Since Javadoc copies the super class' comment if no comment is present, a comment containing only an {@inheritDoc} adds nothing. " Is SonarQube not able to detect this behavior? – michaelbahr Dec 07 '15 at 10:55

Ignore missing documentation if superclass has documentation

1 Answers1

Linked