SchemaTransforms: tweak the documentation (#6747)

martinbonnin · web-flow · commit f56108ca2185 · 2025-10-20T11:49:43.000+02:00
diff --git a/libraries/apollo-compiler/src/main/kotlin/com/apollographql/apollo/compiler/ApolloCompilerPlugin.kt b/libraries/apollo-compiler/src/main/kotlin/com/apollographql/apollo/compiler/ApolloCompilerPlugin.kt
@@ -107,6 +107,8 @@ fun interface SchemaDocumentTransform {
    * Transforms the given schema document.
    *
    * [transform] is called before validation of the schema.
+   *
+   * @param schemaDocument a [GQLDocument] containing all the definitions (possibly from several files) passed as input to the compiler.
    */
   fun transform(schemaDocument: GQLDocument): GQLDocument
 }
@@ -169,7 +171,7 @@ interface ApolloCompilerRegistry {
   /**
    * Registers an [OperationIdsGenerator].
    *
-   * Use this function implement [persisted queries](https://www.apollographql.com/docs/kotlin/advanced/persisted-queries).
+   * Use this function to implement [persisted queries](https://www.apollographql.com/docs/kotlin/advanced/persisted-queries).
    */
   fun registerOperationIdsGenerator(generator: OperationIdsGenerator)
 

Original file line number	Diff line number	Diff line change
`@@ -107,6 +107,8 @@ fun interface SchemaDocumentTransform {`
`107`	`107`	`* Transforms the given schema document.`
`108`	`108`	`*`
`109`	`109`	`* [transform] is called before validation of the schema.`
	`110`	`+ *`
	`111`	`+ * @param schemaDocument a [GQLDocument] containing all the definitions (possibly from several files) passed as input to the compiler.`
`110`	`112`	`*/`
`111`	`113`	`fun transform(schemaDocument: GQLDocument): GQLDocument`
`112`	`114`	`}`
`@@ -169,7 +171,7 @@ interface ApolloCompilerRegistry {`
`169`	`171`	`/**`
`170`	`172`	`* Registers an [OperationIdsGenerator].`
`171`	`173`	`*`
`172`		`- * Use this function implement [persisted queries](https://www.apollographql.com/docs/kotlin/advanced/persisted-queries).`
	`174`	`+ * Use this function to implement [persisted queries](https://www.apollographql.com/docs/kotlin/advanced/persisted-queries).`
`173`	`175`	`*/`
`174`	`176`	`fun registerOperationIdsGenerator(generator: OperationIdsGenerator)`
`175`	`177`