Writing kdocs+tests for generateCode.kt #1311
Conversation
Jolanrensen
changed the title
Jolanrensen
added
KDocs
Jolanrensen
changed the title
| ) | ||
|
|
||
| @Language("kotlin") | ||
| val expected = |
There was a problem hiding this comment.
There are very similar tests on CodeGenerator itself. If you want to test generateDataClasses specifically, maybe you can compare results to results of CodeGenerator?
like df.generateInterfaces should be CodeGenerator.generateCode(...)
So we have less code Strings to refactor should anything change.. or, what do you think?
| * | ||
| * For more information: {@include [DocumentationUrls.DataSchemaGeneration]} | ||
| * | ||
| * @return [CodeString] – A value class wrapper for [String], containing |
There was a problem hiding this comment.
and CodeString.print() utility :)
| public fun <T> DataFrame<T>.generateInterfaces(markerName: String): CodeString = | ||
| schema().generateInterfaces(markerName = markerName) | ||
|
|
||
| /** |
There was a problem hiding this comment.
Please mention that data classes can be used with "toListOf"
| interface UseFqNames | ||
|
|
||
| /** | ||
| * @param nameNormalizer Strategy for converting column names (with spaces, underscores, etc.) to valid Kotlin identifiers. |
There was a problem hiding this comment.
I think it's better to use word "Kotlin-style identifiers" for default normalizer
And
"Generated properties will still refer to columns by their actual name via @ColumnName annotation`
| /** @include [MarkerName] If not specified, generates a name from type [T]. */ | ||
| interface MarkerNameOptional | ||
|
|
||
| /** @param fields Whether to generate fields (`val ...:`) inside the generated data schema declarations (markers). */ |
There was a problem hiding this comment.
How to put it.. Technically field = false, extensions = true is enough to refer to columns in dataframe
But plugin won't be able to extract schema from such dataschema. At least we should state it, at best maybe even remove this option?
| /** @param fields Whether to generate fields (`val ...:`) inside the generated data schema declarations (markers). */ | ||
| interface Fields | ||
|
|
||
| /** @param extensionProperties Whether to generate extension properties in addition to data schema declarations (markers). */ |
There was a problem hiding this comment.
Here we should say that if either compiler plugin or ksp are used in the project, extension properties will conflict with generated ones.
Soo, same as with fields, does it even make sense to have this option..
| interface ExtensionProperties | ||
|
|
||
| /** @param visibility Visibility modifier for the generated declarations (markers). */ | ||
| interface Visibility |
There was a problem hiding this comment.
To add some context, this argument was added to generate valid code for https://kotlinlang.org/docs/api-guidelines-simplicity.html#use-explicit-api-mode
Maybe it's a useful info, maybe not :)
Fixes #1281