Closed scholzj closed 7 months ago
@scholzj @mimaison Do we want to fail the build with missing JavaDoc Warnings by enabling it here in failOnWarnings
by setting it to true?
Should anything be refactored in the checkstyle.xml
file?
The JavaDocs will be added to relevant public methods etc.
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${maven.javadoc.version}</version>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
<configuration>
<show>public</show>
<failOnError>true</failOnError>
<failOnWarnings>true</failOnWarnings>
</configuration>
</execution>
</executions>
</plugin>```
Yes, the warnings should fail the build once the existing Javadoc issues are fixed
Fixed in #19
We normally handle Javadoc warnings (such as missing Javadoc comments) as errors. That is currently disabled in #10. But we should add the missing Javadoc comments and enable it: