Validate javadoc as part of CI build

[tobrun]

With every release we need create additional PRs to fixup javadoc. Take for example #9266, there we had to resolve 50 errors/ 100 warnings before being able to ship. I'm suggesting adding javadoc validation as part of our CI build. Such validation will probably require to inspect output from make android-checkstyle (afaik we can't rely on the exit code as it 's always succesfull even with errors).

cc @mapbox/android

[zugaldia]

@tobrun 👍 x 100.

[cammace]

You can uncomment these lines in the checkstyle file which sets a rule that requires all public methods to have javadoc.

[tobrun]

I tried running with suggestion above but it requires to also fix the javadoc on testapp. @cammace is their a more fine grain control over what a specific checkstyle module validates?

[Guardiola31337]

@tobrun we could use a SuppressionFilter.

Suppressions are specified in a new xml file (e.g. checkstyle-suppressions.xml) and the filter has to be added under Checker in checkstyle.xml:

<module name="SuppressionFilter">
        <property name="file" value="checkstyle-suppressions.xml" />
</module>

[stale]

This issue has been automatically detected as stale because it has not had recent activity and will be archived. Thank you for your contributions.

[stale]

This issue has been automatically detected as stale because it has not had recent activity and will be archived. Thank you for your contributions.

[tobrun]

this is happening as part of #14792