Skip to content

Remove sanitizeKdoc — redundant with KotlinPoet 2.3.0 #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
halotukozak wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Remove sanitizeKdoc — redundant with KotlinPoet 2.3.0 #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions core/src/main/kotlin/com/avsystem/justworks/core/gen/NameUtils.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,6 @@ fun String.toEnumConstantName(): String {
*/
fun String.toInlinedName(): String = replace(".", "_")

/**
* Sanitizes a string for safe inclusion in KDoc.
* Escapes comment terminators that would break generated Kotlin source.
*/
fun String.sanitizeKdoc(): String = replace("*/", "*/")
.replace("/*", "/*")

/**
* Generates a PascalCase operation name from HTTP method and path.
* Path parameters like {id} become "ById", {userId} becomes "ByUserId".
Expand Down
7 changes: 3 additions & 4 deletions core/src/main/kotlin/com/avsystem/justworks/core/gen/client/ClientGenerator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ import com.avsystem.justworks.core.gen.client.BodyGenerator.buildFunctionBody
import com.avsystem.justworks.core.gen.client.ParametersGenerator.buildBodyParams
import com.avsystem.justworks.core.gen.client.ParametersGenerator.buildNullableParameter
import com.avsystem.justworks.core.gen.invoke
import com.avsystem.justworks.core.gen.sanitizeKdoc
import com.avsystem.justworks.core.gen.shared.toAuthParam
import com.avsystem.justworks.core.gen.toCamelCase
import com.avsystem.justworks.core.gen.toPascalCase
Expand Down Expand Up @@ -253,15 +252,15 @@ internal object ClientGenerator {
}

val kdocParts = mutableListOf<String>()
endpoint.summary?.let { kdocParts.add(it.sanitizeKdoc()) }
endpoint.summary?.let { kdocParts.add(it) }
endpoint.description?.let {
if (kdocParts.isNotEmpty()) kdocParts.add("")
kdocParts.add(it.sanitizeKdoc())
kdocParts.add(it)
}
val paramDocs = endpoint.parameters.filter { it.description != null }
if (paramDocs.isNotEmpty() && kdocParts.isNotEmpty()) kdocParts.add("")
paramDocs.forEach { param ->
kdocParts.add("@param ${param.name.toCamelCase()} ${param.description?.sanitizeKdoc()}")
kdocParts.add("@param ${param.name.toCamelCase()} ${param.description}")
}
if (kdocParts.isNotEmpty()) {
funBuilder.addKdoc("%L", kdocParts.joinToString("\n"))
Expand Down
15 changes: 7 additions & 8 deletions core/src/main/kotlin/com/avsystem/justworks/core/gen/model/ModelGenerator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ import com.avsystem.justworks.core.gen.model.ModelGenerator.generateDataClass
import com.avsystem.justworks.core.gen.resolveInlineTypes
import com.avsystem.justworks.core.gen.resolveSerialName
import com.avsystem.justworks.core.gen.resolveTypeRef
import com.avsystem.justworks.core.gen.sanitizeKdoc
import com.avsystem.justworks.core.gen.shared.SerializersModuleGenerator
import com.avsystem.justworks.core.gen.toCamelCase
import com.avsystem.justworks.core.gen.toEnumConstantName
Expand Down Expand Up @@ -206,7 +205,7 @@ internal object ModelGenerator {
}

if (schema.description != null) {
parentBuilder.addKdoc("%L", schema.description.sanitizeKdoc())
parentBuilder.addKdoc("%L", schema.description)
}

// Generate nested subtypes
Expand Down Expand Up @@ -308,15 +307,15 @@ internal object ModelGenerator {
.builder(kotlinName, type)
.initializer(kotlinName)
.addAnnotation(AnnotationSpec.builder(SERIAL_NAME).addMember("%S", prop.name).build())
.apply { prop.description?.let { addKdoc("%L", it.sanitizeKdoc()) } }
.apply { prop.description?.let { addKdoc("%L", it) } }
.build()
}

builder.primaryConstructor(constructorBuilder.build())
builder.addProperties(propertySpecs)

if (schema.description != null) {
builder.addKdoc("%L", schema.description.sanitizeKdoc())
builder.addKdoc("%L", schema.description)
}
}

Expand All @@ -339,7 +338,7 @@ internal object ModelGenerator {
)

if (schema.description != null) {
typeSpec.addKdoc("%L", schema.description.sanitizeKdoc())
typeSpec.addKdoc("%L", schema.description)
}

return FileSpec.builder(className).addType(typeSpec.build()).build()
Expand Down Expand Up @@ -565,13 +564,13 @@ internal object ModelGenerator {
.builder(SERIAL_NAME)
.addMember("%S", value.name)
.build(),
).apply { value.description?.let { addKdoc("%L", it.sanitizeKdoc()) } }
).apply { value.description?.let { addKdoc("%L", it) } }
.build()
typeSpec.addEnumConstant(enumRegistry.register(value.name.toEnumConstantName()), anonymousClass)
}

if (enum.description != null) {
typeSpec.addKdoc("%L", enum.description.sanitizeKdoc())
typeSpec.addKdoc("%L", enum.description)
}

return FileSpec
Expand Down Expand Up @@ -682,7 +681,7 @@ internal object ModelGenerator {
val typeAlias = TypeAliasSpec.builder(schema.name, primitiveType)

if (schema.description != null) {
typeAlias.addKdoc("%L", schema.description.sanitizeKdoc())
typeAlias.addKdoc("%L", schema.description)
}

return FileSpec
Expand Down
Loading