review fixes

Author: onewhl

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/tree/CgElement.kt

@@ -337,6 +337,9 @@ class CgDocPreTagStatement(content: List<CgDocStatement>) : CgDocTagStatement(co
     override fun hashCode(): Int = content.hashCode()
 }
 
+/**
+ * Represents a type for statements containing custom JavaDoc tags.
+ */
 data class CgCustomTagStatement(val statements: List<CgDocStatement>) : CgDocTagStatement(statements)
 
 class CgDocCodeStmt(val stmt: String) : CgDocStatement() {

utbot-summary/src/main/kotlin/org/utbot/summary/Summarization.kt

@@ -155,12 +155,14 @@ class Summarization(val sourceFile: File?, val invokeDescriptions: List<InvokeDe
                 }
 
                 for (traceTags in clusterTraceTags.traceTags) {
-                    if (GENERATE_COMMENTS && UtSettings.useCustomJavaDocTags) {
-                        traceTags.execution.summary =
-                            CustomJavaDocCommentBuilder(traceTags, sootToAST).buildDocStatements(methodUnderTest)
-                    } else if (GENERATE_COMMENTS) {
-                        traceTags.execution.summary =
-                            SimpleCommentBuilder(traceTags, sootToAST).buildDocStmts(methodUnderTest)
+                    if (GENERATE_COMMENTS) {
+                        if (UtSettings.useCustomJavaDocTags) {
+                            traceTags.execution.summary =
+                                CustomJavaDocCommentBuilder(traceTags, sootToAST).buildDocStatements(methodUnderTest)
+                        } else {
+                            traceTags.execution.summary =
+                                SimpleCommentBuilder(traceTags, sootToAST).buildDocStmts(methodUnderTest)
+                        }
                     }
 
                     if (GENERATE_DISPLAY_NAMES || GENERATE_NAMES) {

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

@@ -7,6 +7,9 @@ import org.utbot.summary.ast.JimpleToASTMap
 import org.utbot.summary.tag.TraceTagWithoutExecution
 import soot.SootMethod
 
+/**
+ * Builds JavaDoc comments for generated tests using plugin's custom JavaDoc tags.
+ */
 class CustomJavaDocCommentBuilder(
     traceTag: TraceTagWithoutExecution,
     sootToAST: MutableMap<SootMethod, JimpleToASTMap>
@@ -72,7 +75,7 @@ class CustomJavaDocCommentBuilder(
                     StmtType.Condition -> customJavaDocComment.executesCondition += "{@code ${statement.description}}"
                     StmtType.Return -> customJavaDocComment.returnsFrom = "{@code ${statement.description}}"
                     else -> {
-                        //TODO: do we need to handle others?
+                        //TODO: see [issue-773](https://github.com/UnitTestBot/UTBotJava/issues/773)
                     }
                 }
             }