Add comments, remove unused method

Author: onewhl

utbot-intellij/src/main/kotlin/org/utbot/intellij/plugin/javadoc/UtJavaDocInfoGenerator.kt

@@ -22,10 +22,14 @@ private const val MESSAGE_SEPARATOR = ":"
 
 private val logger = KotlinLogging.logger {}
 
+/**
+ * Generates UtBot specific sections to include them to rendered JavaDoc comment.
+ *
+ * Methods responsible for value generation were taken from IJ platform class (they are private and couldn't be used outside).
+ *
+ * See [com.intellij.codeInsight.javadoc.JavaDocInfoGenerator].
+ */
 class UtJavaDocInfoGenerator {
-    /**
-     * Generates UtBot specific sections to include them to rendered JavaDoc comment.
-     */
     fun addUtBotSpecificSectionsToJavaDoc(javadoc: String?, comment: PsiDocComment): String {
         val builder: StringBuilder = StringBuilder(javadoc)
         val docTagProvider = UtCustomJavaDocTagProvider()

utbot-summary-tests/src/test/kotlin/examples/CustomJavaDocTagsEnabler.kt

@@ -5,6 +5,12 @@ import org.junit.jupiter.api.extension.BeforeEachCallback
 import org.junit.jupiter.api.extension.ExtensionContext
 import org.utbot.framework.UtSettings
 
+/**
+ * Controls the value of useCustomJavaDocTags global variable.
+ *
+ * Should be used in summary tests containing custom JavaDoc tags.
+ * To use it, add an annotation @ExtendWith(CustomJavaDocTagsEnabler::class) under test class.
+ */
 class CustomJavaDocTagsEnabler(private val enable: Boolean = true) : BeforeEachCallback, AfterEachCallback {
     private var previousValue = false
 

utbot-summary-tests/src/test/kotlin/examples/SummaryTestCaseGeneratorTest.kt

@@ -160,52 +160,6 @@ open class SummaryTestCaseGeneratorTest(
         }
     }
 
-    fun List<UtExecution>.checkMatchersWithCustomTagsInSummary(
-        comments: List<String>
-    ) {
-        if (comments.isEmpty()) {
-            return
-        }
-
-        val notMatchedExecutions = this.filter { execution ->
-            comments.none { comment ->
-                execution.summary?.toString()?.contains(comment) == true
-            }
-        }
-
-        val notMatchedComments = comments.filter { comment ->
-            this.none { execution ->
-                execution.summary?.toString()?.contains(comment) == true
-            }
-        }
-
-        Assertions.assertTrue(notMatchedExecutions.isEmpty() && notMatchedComments.isEmpty()) {
-            buildString {
-                if (notMatchedExecutions.isNotEmpty()) {
-                    append(
-                        "\nThe following comments were produced by the UTBot, " +
-                                "but were not found in the list of comments passed in the check() method:\n\n${
-                                    commentsFromExecutions(
-                                        notMatchedExecutions
-                                    )
-                                }"
-                    )
-                }
-
-                if (notMatchedComments.isNotEmpty()) {
-                    append(
-                        "\nThe following comments were passed in the check() method, " +
-                                "but were not found in the list of comments produced by the UTBot:\n\n${
-                                    comments(
-                                        notMatchedComments
-                                    )
-                                }"
-                    )
-                }
-            }
-        }
-    }
-
     fun List<UtExecution>.checkMatchersWithMethodNames(
         methodNames: List<String>,
     ) {

utbot-summary/src/main/kotlin/org/utbot/summary/comment/SimpleCommentBuilder.kt

@@ -119,7 +119,7 @@ open class SimpleCommentBuilder(
         return stmts
     }
 
-    fun findExceptionReason(currentMethod: SootMethod, thrownException: Throwable): String {
+    protected fun findExceptionReason(currentMethod: SootMethod, thrownException: Throwable): String {
         val path = traceTag.path
         if (path.isEmpty()) {
             if (thrownException is ConcreteExecutionFailureException) {