Skip to content

Commit a996fe2

Browse files
committed
Improve rendering of UtUtils documentation
1 parent 889082d commit a996fe2

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/domain/models/CgElement.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@ open class CgClassFile(
124124

125125
class CgClass(
126126
val id: ClassId,
127+
val documentation: CgDocumentationComment?,
127128
val annotations: List<CgAnnotation>,
128129
val superclass: ClassId?,
129130
val interfaces: List<ClassId>,
@@ -149,7 +150,6 @@ class CgClass(
149150
*/
150151
class CgClassBody(
151152
val classId: ClassId,
152-
val documentation: CgDocumentationComment?,
153153
val methodRegions: List<CgMethodsCluster>,
154154
val staticDeclarationRegions: List<CgStaticsRegion>,
155155
val nestedClassRegions: List<CgNestedClassesRegion<*>>

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/renderer/CgJavaRenderer.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ internal class CgJavaRenderer(context: CgRendererContext, printer: CgPrinter = C
6161
get() = this == context.generatedClass
6262

6363
override fun visit(element: CgClass) {
64+
element.documentation?.accept(this)
65+
6466
for (annotation in element.annotations) {
6567
annotation.accept(this)
6668
}
@@ -87,8 +89,6 @@ internal class CgJavaRenderer(context: CgRendererContext, printer: CgPrinter = C
8789
}
8890

8991
override fun visit(element: CgClassBody) {
90-
element.documentation?.accept(this)
91-
9292
// render regions for test methods and utils
9393
val allRegions = element.methodRegions + element.nestedClassRegions + element.staticDeclarationRegions
9494
for ((i, region) in allRegions.withIndex()) {

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/renderer/CgKotlinRenderer.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,8 @@ internal class CgKotlinRenderer(context: CgRendererContext, printer: CgPrinter =
7575
get() = (this == context.generatedClass) || isKotlinFile
7676

7777
override fun visit(element: CgClass) {
78+
element.documentation?.accept(this)
79+
7880
for (annotation in element.annotations) {
7981
annotation.accept(this)
8082
}
@@ -115,8 +117,6 @@ internal class CgKotlinRenderer(context: CgRendererContext, printer: CgPrinter =
115117
}
116118

117119
override fun visit(element: CgClassBody) {
118-
element.documentation?.accept(this)
119-
120120
// render regions for test methods
121121
for ((i, region) in (element.methodRegions + element.nestedClassRegions).withIndex()) {
122122
if (i != 0) println()

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,25 +49,25 @@ fun buildClassFile(init: CgClassFileBuilder.() -> Unit) = CgClassFileBuilder().a
4949

5050
class CgClassBuilder : CgBuilder<CgClass> {
5151
lateinit var id: ClassId
52+
var documentation: CgDocumentationComment? = null
5253
val annotations: MutableList<CgAnnotation> = mutableListOf()
5354
var superclass: ClassId? = null
5455
val interfaces: MutableList<ClassId> = mutableListOf()
5556
var isStatic: Boolean = false
5657
var isNested: Boolean = false
5758
lateinit var body: CgClassBody
5859

59-
override fun build() = CgClass(id, annotations, superclass, interfaces, body, isStatic, isNested)
60+
override fun build() = CgClass(id, documentation, annotations, superclass, interfaces, body, isStatic, isNested)
6061
}
6162

6263
fun buildClass(init: CgClassBuilder.() -> Unit) = CgClassBuilder().apply(init).build()
6364

6465
class CgClassBodyBuilder(val classId: ClassId) : CgBuilder<CgClassBody> {
65-
var documentation: CgDocumentationComment? = null
6666
val methodRegions: MutableList<CgMethodsCluster> = mutableListOf()
6767
val staticDeclarationRegions: MutableList<CgStaticsRegion> = mutableListOf()
6868
val nestedClassRegions: MutableList<CgNestedClassesRegion<*>> = mutableListOf()
6969

70-
override fun build() = CgClassBody(classId, documentation, methodRegions, staticDeclarationRegions, nestedClassRegions)
70+
override fun build() = CgClassBody(classId, methodRegions, staticDeclarationRegions, nestedClassRegions)
7171
}
7272

7373
fun buildClassBody(classId: ClassId, init: CgClassBodyBuilder.() -> Unit) = CgClassBodyBuilder(classId).apply(init).build()

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/tree/ututils/CgUtilClassConstructor.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ internal object CgUtilClassConstructor {
2727
// so they will be imported once IDEA reformatting action has worked
2828
declaredClass = buildClass {
2929
id = utilsClassId
30+
documentation = utilClassKind.utilClassDocumentation(codegenLanguage)
3031
body = buildClassBody(utilsClassId) {
31-
documentation = utilClassKind.utilClassDocumentation(codegenLanguage)
3232
staticDeclarationRegions += CgStaticsRegion("Util methods", utilMethodProvider.utilMethodIds.map { CgUtilMethod(it) })
3333
nestedClassRegions += CgAuxiliaryNestedClassesRegion(
3434
nestedClasses = listOf(

0 commit comments

Comments
 (0)