GQLGW-4167 Add clarifying JavaDoc (#661)

Co-authored-by: Donna Zhou <[email protected]>
atlassian-labs · Dec 27, 2024 · 38ac346 · 38ac346
1 parent 4d943df
commit 38ac346
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/lib/src/main/java/graphql/nadel/engine/transform/NadelTransform.kt b/lib/src/main/java/graphql/nadel/engine/transform/NadelTransform.kt
@@ -31,6 +31,8 @@ interface NadelTransform<State : Any> {
      * e.g. the names of fields that will be added etc. The implementation of [State] is completely up
      * to you. You can make it mutable if that makes your life easier etc.
      *
+     * Note: a transform is applied to all fields recursively
+     *
      * @param executionBlueprint the [NadelOverallExecutionBlueprint] of the Nadel instance being operated on
      * @param service the [Service] the [overallField] belongs to
      * @param overallField the [ExecutableNormalizedField] in question, we are asking whether it [isApplicable] for transforms

diff --git a/lib/src/main/java/graphql/nadel/engine/transform/NadelTransformJavaCompat.kt b/lib/src/main/java/graphql/nadel/engine/transform/NadelTransformJavaCompat.kt
@@ -24,6 +24,8 @@ interface NadelTransformJavaCompat<State : Any> {
 
     /**
      * See [NadelTransform.isApplicable]
+     *
+     * Note: a transform is applied to all fields recursively
      */
     fun isApplicable(
         executionContext: NadelExecutionContext,