From cf3e34e548f0ef013f05f4fdf4fef959db27e701 Mon Sep 17 00:00:00 2001
From: Benoit Marty <benoit@matrix.org>
Date: Fri, 13 May 2022 09:51:14 +0200
Subject: [PATCH] Detekt: add rules about comment

---
 tools/detekt/detekt.yml | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/tools/detekt/detekt.yml b/tools/detekt/detekt.yml
index f1730fc196..fc9f42e4f5 100644
--- 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