Detekt: add rules about comment

element-hq · May 13, 2022 · cf3e34e · cf3e34e
1 parent d17a273
commit cf3e34e
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/tools/detekt/detekt.yml b/tools/detekt/detekt.yml
@@ -71,3 +71,28 @@ naming:
 performance:
   SpreadOperator:
     active: false
+
+# Note: all rules for `comments` are disabled by default, but I put them here to be aware of their existence
+comments:
+  AbsentOrWrongFileLicense:
+    active: false
+    licenseTemplateFile: 'license.template'
+    licenseTemplateIsRegex: false
+  CommentOverPrivateFunction:
+    active: false
+  CommentOverPrivateProperty:
+    active: false
+  DeprecatedBlockTag:
+    active: true
+  EndOfSentenceFormat:
+    # TODO Enable it
+    active: false
+  OutdatedDocumentation:
+    # TODO Enable it
+    active: false
+  UndocumentedPublicClass:
+    active: false
+  UndocumentedPublicFunction:
+    active: false
+  UndocumentedPublicProperty:
+    active: false