From a7c730f34dffebbf15195bd617b7e02b55176fe8 Mon Sep 17 00:00:00 2001
From: Yi Hsuen <tayyihsuen@gmail.com>
Date: Sun, 29 May 2022 14:35:07 +0800
Subject: [PATCH] Update check comments

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.
---
 config/checkstyle/checkstyle.xml | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml
index ca472b955df..0b2e6346c9b 100644
--- a/config/checkstyle/checkstyle.xml
+++ b/config/checkstyle/checkstyle.xml
@@ -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"/>
@@ -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"/>