Skip to content

Commit

Permalink
Exempt main method from javadoc requirement
Browse files Browse the repository at this point in the history
Let's update checkstyle.xml to omit the main method from
the javadoc requirement, as the purpose of the main method
is clear.
  • Loading branch information
Eclipse-Dominator authored and damithc committed Aug 4, 2023
1 parent e9f1ca7 commit 3dbe70e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion config/checkstyle/checkstyle.xml
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@
<module name="MissingJavadocMethodCheck">
<property name="minLineCount" value="1"/>
<property name="allowMissingPropertyJavadoc" value="true"/>
<property name="ignoreMethodNamesRegex" value="(set.*|get.*)"/>
<property name="ignoreMethodNamesRegex" value="(set.*|get.*|main)"/>
</module>

<!-- Checks that every public class, enumeration and interface has a header comment. -->
Expand Down

0 comments on commit 3dbe70e

Please sign in to comment.