On Sat, 25 Jun 2022 at 10:07, Alex Herbert <alex.d.herb...@gmail.com> wrote:

>
>
> Checkstyle:
> Checkstyle plugin is configured to failOnViolation. So it is not
> complaining about lack of comments. We are using the following rules:
>
> InvalidJavadocPosition,JavadocMethod,JavadocType,JavadocVariable,JavadocStyle
>
> So the failure of checkstyle to fail is strange. If I take an existing
> file and make some formatting changes it fails the build. If I delete a tag
> from the javadoc it fails the build. If I delete the entire javadoc then
> this passes. So checkstyle checks the existing javadoc but does not fail
> when javadoc is missing. This requires further investigation.
>

This requires extra checks:

MissingJavadocMethod
MissingJavadocPackage
MissingJavadocType

I will add these to our checkstyle configs and fix any failures (since
these are scoped to private by default there may be some missing javadoc).

See:
http://checkstyle.sourceforge.net/config_javadoc.html

Reply via email to