fix rendering after updating to idea 2022.1. now we don't need to generate comment content with HTML tags, we need only replace custom tags' names with their messages to make it look nice

Author: onewhl

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

@@ -1,16 +1,14 @@
 package org.utbot.intellij.plugin.javadoc
 
 import com.intellij.codeInsight.javadoc.JavaDocExternalFilter
-import com.intellij.codeInsight.javadoc.JavaDocInfoGenerator
+import com.intellij.codeInsight.javadoc.JavaDocInfoGeneratorFactory
 import com.intellij.lang.java.JavaDocumentationProvider
 import com.intellij.psi.PsiDocCommentBase
 import com.intellij.psi.PsiJavaDocumentedElement
 
 /**
- * To render UtBot custom JavaDoc tags correctly, we need to override the way it generates HTML tags for comments.
- * We get JavaDoc info generated by IJ platform and include sections related to UTBot,
- * each section relates to the specific JavaDoc tag.
- * It renders text, code, and links.
+ * To render UtBot custom JavaDoc tags messages, we need to override basic behaviour of [JavaDocumentationProvider].
+ * The IJ platform knows only custom tag names, so we need to add their messages in rendered comments to make it look nice.
  */
 class UtDocumentationProvider : JavaDocumentationProvider() {
     override fun generateRenderedDoc(comment: PsiDocCommentBase): String? {
@@ -20,16 +18,29 @@ class UtDocumentationProvider : JavaDocumentationProvider() {
             return ""
         }
 
-        val docComment = target.docComment ?: return ""
+        val baseJavaDocInfoGenerator = JavaDocInfoGeneratorFactory.getBuilder(target.getProject())
+            .setPsiElement(target)
+            .setIsGenerationForRenderedDoc(true)
+            .create()
 
-        val baseJavaDocInfoGenerator = JavaDocInfoGenerator(target.project, target)
-        // get JavaDoc comment rendered by the platform.
-        val baseJavaDocInfo = baseJavaDocInfoGenerator.generateRenderedDocInfo()
-        val utJavaDocInfoGenerator = UtJavaDocInfoGenerator()
-        // add UTBot sections with custom tags.
-        val javaDocInfoWithUtSections =
-            utJavaDocInfoGenerator.addUtBotSpecificSectionsToJavaDoc(baseJavaDocInfo, docComment)
+        val finalDocContent = replaceTagNamesWithMessages(baseJavaDocInfoGenerator.generateRenderedDocInfo())
 
-        return JavaDocExternalFilter.filterInternalDocInfo(javaDocInfoWithUtSections)
+        return JavaDocExternalFilter.filterInternalDocInfo(finalDocContent)
     }
+
+    /**
+     * Replaces names of plugin's custom JavaDoc tags with their messages in the comment generated by the IJ platform.
+     * Example: utbot.MethodUnderTest -> Method under test.
+     */
+    private fun replaceTagNamesWithMessages(comment: String?) =
+        comment?.let {
+            val docTagProvider = UtCustomJavaDocTagProvider()
+            docTagProvider.supportedTags.fold(it) { result, tag ->
+                if (result.contains(tag.name)) {
+                    result.replace(tag.name, "${tag.getMessage()}:")
+                } else {
+                    result
+                }
+            }
+        } ?: ""
 }