Add javadoc to GraphQLError based on GraphQL Spec

tlovett-rmn · andimarek · commit 3a7cf5b90a13 · 2017-06-22T22:37:45.000+02:00
diff --git a/src/main/java/graphql/GraphQLError.java b/src/main/java/graphql/GraphQLError.java
@@ -5,11 +5,21 @@
 
 import java.util.List;
 
+/**
+ * @see <a href="https://facebook.github.io/graphql/#sec-Errors">GraphQL Spec - 7.2.2 Errors</a>
+ */
 @PublicApi
 public interface GraphQLError {
 
+    /**
+     * @return a description of the error intended for the developer as a guide to understand and correct the error
+     */
     String getMessage();
 
+    /**
+     * @return the location(s) within the GraphQL document at which the error occurred. Each {@link SourceLocation}
+     * describes the beginning of an associated syntax element
+     */
     List<SourceLocation> getLocations();
 
     ErrorType getErrorType();
