Merge pull request #128 from novuhq/feat-code-documentation

Write Code Documentations
novuhq · Jun 16, 2024 · d57ba06 · d57ba06
2 parents bff4a66 + 041110e
commit d57ba06
Show file tree

Hide file tree

Showing 7 changed files with 902 additions and 176 deletions.
diff --git a/README.md b/README.md
diff --git a/config/checkstyle/checkstyle-suppressions.xml b/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>
diff --git a/config/checkstyle/checkstyle.xml b/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"/>