Skip to content

Commit

Permalink
Checkstyle: don't require javadoc on test methods (elastic#88179)
Browse files Browse the repository at this point in the history
Test methods tend to have descriptive names for the cases that they are
testing. Sometimes they require javadoc, for sure, but not often enough
to add a little "WEAK WARNING" marker on every single test method in my
IDE.

Co-authored-by: Elastic Machine <[email protected]>
  • Loading branch information
nik9000 and elasticmachine authored Jun 30, 2022
1 parent e2337bc commit aa6f31f
Showing 1 changed file with 1 addition and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<!-- Exclude short methods from this check - we don't want to have to document getters -->
<property name="minLineCount" value="5" />
<property name="allowedAnnotations" value="Override,Before,BeforeClass,After,AfterClass,Inject,TaskAction" />
<property name="ignoreMethodNamesRegex" value="^main$"/>
<property name="ignoreMethodNamesRegex" value="^(main|test.*)$"/>
<message key="javadoc.missing" value="Public methods should be documented." />
</module>

Expand Down

0 comments on commit aa6f31f

Please sign in to comment.