Skip to content

Commit 6ce3bf1

Browse files
committed
chore(codegen): KotlinTypeMapper: update documentation comments
1 parent 20fcb8d commit 6ce3bf1

File tree

1 file changed

+8
-2
lines changed
  • graphql-kotlin-toolkit-codegen/src/main/kotlin/com/auritylab/graphql/kotlin/toolkit/codegen/mapper

1 file changed

+8
-2
lines changed

graphql-kotlin-toolkit-codegen/src/main/kotlin/com/auritylab/graphql/kotlin/toolkit/codegen/mapper/KotlinTypeMapper.kt

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,14 @@ internal class KotlinTypeMapper(
3737
private val generatedMapper: GeneratedMapper
3838
) {
3939
/**
40-
* Will try to find a corresponding [TypeName] for the given [type].
41-
* The returned types already assume the incoming data has been parsed.
40+
* Will resolve the [TypeName] for the given [GraphQLType]. The returned types already assume the incoming data
41+
* has been parsed into internal types. You can additionally supply a [fieldDirectiveContainer] which can be for
42+
* example the [graphql.schema.GraphQLFieldDefinition]. A custom [listType] can also be supplied if needed.
43+
*
44+
* @param type The type for which to create the [TypeName] for.
45+
* @param fieldDirectiveContainer The directive container for additional specification of the type.
46+
* @param listType A custom type for lists.
47+
* @return The resolved [TypeName] for the given [type].
4248
*/
4349
fun getKotlinType(
4450
type: GraphQLType,

0 commit comments

Comments
 (0)