Write Code Documentations

config/checkstyle/checkstyle-suppressions.xml

@@ -7,6 +7,9 @@
     <suppress checks="JavadocPackage" files="."/>
     <suppress checks="HideUtilityClassConstructor" files="."/>
     <suppress checks="JavadocType" files="."/>
-    <suppress checks="JavadocMethod" files="."/>
+    <suppress checks="JavadocMethod" files="co[\\/]novu[\\/]api[\\/]"/>
+    <suppress checks="JavadocMethod" files="co[\\/]novu[\\/]common[\\/]rest[\\/]"/>
+    <suppress checks="MissingJavadocMethod" files="co[\\/]novu[\\/]api[\\/]"/>
+    <suppress checks="MissingJavadocMethod" files="co[\\/]novu[\\/]common[\\/]rest[\\/]"/>
     <suppress checks="JavadocVariable" files="."/>
 </suppressions>

config/checkstyle/checkstyle.xml

@@ -101,7 +101,9 @@
         <!-- Checks for Javadoc comments.                     -->
         <!-- See https://checkstyle.org/checks/javadoc/index.html -->
         <module name="InvalidJavadocPosition"/>
-        <module name="JavadocMethod"/>
+        <module name="JavadocMethod">
+            <property name="accessModifiers" value="public"/>
+        </module>
         <module name="JavadocType"/>
         <module name="JavadocVariable"/>
         <module name="JavadocStyle"/>