improve javadoc, mark as public spi

andimarek · andimarek · commit 088dfa5aa404 · 2017-05-20T03:58:47.000+02:00
diff --git a/src/main/java/graphql/schema/Coercing.java b/src/main/java/graphql/schema/Coercing.java
@@ -1,6 +1,9 @@
 package graphql.schema;
 
 
+import graphql.PublicSpi;
+
+@PublicSpi
 public interface Coercing<I, O> {
 
 
@@ -25,7 +28,7 @@ public interface Coercing<I, O> {
      * Called to convert a AST node
      *
      * @param input is never null
-     * @return null if not possible/invalid
+     * @return A null value indicates that the literal is not valid. See {@link graphql.validation.ValidationUtil#isValidLiteralValue}
      */
     I parseLiteral(Object input);
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,9 @@`
`1`	`1`	`package graphql.schema;`
`2`	`2`
`3`	`3`
	`4`	`+import graphql.PublicSpi;`
	`5`	`+`
	`6`	`+@PublicSpi`
`4`	`7`	`public interface Coercing<I, O> {`
`5`	`8`
`6`	`9`
`@@ -25,7 +28,7 @@ public interface Coercing<I, O> {`
`25`	`28`	`* Called to convert a AST node`
`26`	`29`	`*`
`27`	`30`	`* @param input is never null`
`28`		`- * @return null if not possible/invalid`
	`31`	`+ * @return A null value indicates that the literal is not valid. See {@link graphql.validation.ValidationUtil#isValidLiteralValue}`
`29`	`32`	`*/`
`30`	`33`	`I parseLiteral(Object input);`
`31`	`34`	`}`