add/fix javadoc

andimarek · andimarek · commit eafa3a31e608 · 2017-08-29T08:53:17.000+02:00
diff --git a/src/main/java/graphql/analysis/FieldComplexityCalculator.java b/src/main/java/graphql/analysis/FieldComplexityCalculator.java
@@ -2,10 +2,21 @@
 
 import graphql.PublicApi;
 
+/**
+ * Used to calculate the complexity of a field. Used by {@link MaxQueryComplexityInstrumentation}.
+ */
 @PublicApi
 @FunctionalInterface
 public interface FieldComplexityCalculator {
 
+    /**
+     * Calculates the complexity of a field
+     *
+     * @param environment     several information about the current field
+     * @param childComplexity the sum of all child complexity scores
+     *
+     * @return the calculated complexity
+     */
     int calculate(FieldComplexityEnvironment environment, int childComplexity);
 
 }
diff --git a/src/main/java/graphql/analysis/MaxQueryComplexityInstrumentation.java b/src/main/java/graphql/analysis/MaxQueryComplexityInstrumentation.java
@@ -15,7 +15,7 @@
 import static graphql.Assert.assertNotNull;
 
 /**
- * Prevents execution if the query complexity is greater than the specified maxDepth
+ * Prevents execution if the query complexity is greater than the specified maxComplexity
  */
 @PublicApi
 public class MaxQueryComplexityInstrumentation extends NoOpInstrumentation {
