Skip to content

Commit

Permalink
Update check comments
Browse files Browse the repository at this point in the history
The JavadocType and JavadocMethod checks are meant to check that the
Javadoc comments follow the appropriate format. On the other hand, the
MissingJavadocMethodCheck checks whether the method has missing Javadoc.

Let's update the comments to describe these checks.
  • Loading branch information
yhtMinceraft1010X authored and damithc committed Jul 19, 2022
1 parent e726a5b commit a7c730f
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions config/checkstyle/checkstyle.xml
Original file line number Diff line number Diff line change
Expand Up @@ -376,12 +376,12 @@
JAVADOC CHECKS
-->

<!-- Checks that every class, enumeration and interface have a header comment. -->
<!-- Checks the Javadoc's format for every class, enumeration and interface. -->
<module name="JavadocType">
<property name="allowMissingParamTags" value="true"/>
</module>

<!-- Checks that every public method (excluding getters, setters and constructors) has a header comment. -->
<!-- Checks the Javadoc's format for every public method (excluding getters, setters and constructors). -->
<module name="JavadocMethod">
<property name="allowedAnnotations" value="Override, Test, BeforeAll, BeforeEach, AfterAll, AfterEach, Subscribe"/>
<property name="accessModifiers" value="public"/>
Expand All @@ -393,6 +393,7 @@

<module name="InvalidJavadocPosition"/>

<!-- Checks that every public method (excluding getters, setters and constructors) has a header comment. -->
<module name="MissingJavadocMethodCheck">
<property name="minLineCount" value="1"/>
<property name="allowMissingPropertyJavadoc" value="true"/>
Expand Down

0 comments on commit a7c730f

Please sign in to comment.