Merge pull request #530 from overblog/murtukov-patch-1

Update annotations-reference.md

Author: murtukov

docs/annotations/annotations-reference.md

@@ -41,48 +41,50 @@ class Coordinates {
 
 ## Index
 
-@Access
+[@Access](#access)
 
-@Arg
+[@Arg](#arg)
 
-@Deprecated
+[@Deprecated](#deprecated)
 
-@Description
+[@Description](#description)
 
-@Enum
+[@Enum](#enum)
 
-@EnumValue
+[@EnumValue](#enumvalue)
 
-@Field
+[@Field](#field)
 
-@FieldsBuilder
+[@FieldsBuilder](#fieldsbuilder)
 
-@Input
+[@Input](#input)
 
-@IsPublic
+[@IsPublic](#ispublic)
 
-@Mutation
+[@Mutation](#mutation)
 
-@Provider
+[@Provider](#provider)
 
-@Query
+[@Query](#query)
 
-@Type
+[@Type](#type)
 
-@TypeInterface
+[@TypeInterface](#typeinterface)
 
-@Scalar
+[@Scalar](#scalar)
 
-@Union
+[@Union](#union)
 
-@Relay\Connection
+[@Relay\Connection](#relayconnection)
 
-@Relay\Edge
+[@Relay\Edge](#relayedge)
+
+---
 
 ## @Access
 
-Added on a _class_ in conjonction with `@Type` or `@TypeInterface`, this annotation will define the default access type on this fields.  
-Added on a _property_ or _method_ in conjonction with `@Field`, it'll define the access type on this particular field.
+Added on a _class_ in conjunction with `@Type` or `@TypeInterface`, this annotation will define the default access type on this fields.  
+Added on a _property_ or _method_ in conjunction with `@Field`, it'll define the access type on this particular field.
 
 Example:
 
@@ -105,7 +107,6 @@ class Hero {
      */
     public $secret;
 }
-?>
 ```
 
 ## @Arg
@@ -146,12 +147,11 @@ class Hero {
      */
     public $friends;
 }
-?>
 ```
 
 ## @Deprecated
 
-This annotation is used in conjonction with `@Field` to mark it as deprecated with the specified reason.
+This annotation is used in conjunction with `@Field` to mark it as deprecated with the specified reason.
 
 Example
 
@@ -173,12 +173,11 @@ class Hero {
      */
     public $age;
 }
-?>
 ```
 
 ## @Description
 
-This annotation is used in conjonction with one of `@Enum`, `@Field`, `@Input`, `@Scalar`, `@Type`, `@TypeInterface`, `@Union` to set a description for the GraphQL object.
+This annotation is used in conjunction with one of `@Enum`, `@Field`, `@Input`, `@Scalar`, `@Type`, `@TypeInterface`, `@Union` to set a description for the GraphQL object.
 
 Example
 
@@ -196,12 +195,11 @@ class Hero {
      */
     public $name;
 }
-?>
 ```
 
 ## @Enum
 
-This annotation applies on _class_ to define it as a enum. The constants defined on the class will be the enum values.  
+This annotation applies on _class_ to define it as a `enum`. The constants defined on the class will be the enum values.  
 In order to add more meta on the values (like description or deprecated reason), you have to provided them as `@EnumValue` in the `values` attribute with a `name` attribute referencing a constant name. You just need to do it for the constants you want to add meta on.
 
 Optional attributes:
@@ -232,10 +230,9 @@ class Planet
 
     public $value;
 }
-?>
 ```
 
-In the example above, if a query or mutation has this Enum as an argument, the value will be an instanceof the class with the enum value as the `value` property. (see [The Arguments Transformer documentation](arguments-transformer.md)).  
+In the example above, if a query or mutation has this Enum as an argument, the value will be an instance of the class with the enum value as the `value` property. (see [The Arguments Transformer documentation](arguments-transformer.md)).  
 As the class can be instanciated from the `Arguments Transformer` service, it cannot have a constructor with required arguments.
 
 ## @EnumValue
@@ -257,17 +254,17 @@ This annotation can be defined on a _property_ or a _method_.
 
 If it is defined on a _method_:
 
--   If no `resolve` attribute is define, it will default to `@=value.methodName(...args)"`, so the method itself will be used as the field resolver. You can then specify a `name` for this field (or it's the method name that will be use).
+-   If no `resolve` attribute is defined, it will default to `@=value.methodName(...args)"`, so the method itself will be used as the field resolver. You can then specify a `name` for this field (or the method's name will be use).
 
 If it is defined on a _method_ of the Root Query or the Root mutation :
 
--   If not `resolve` attribute is define, it will default to `@=service(FQN).methodName(...args)"` with `FQN` being the fully qualified name of the Root Query class or Root Mutation.
+-   If not `resolve` attribute is defined, it will default to `@=service(FQN).methodName(...args)"` with `FQN` being the fully qualified name of the Root Query class or Root Mutation.
 
 Optional attributes:
 
--   **type** : The GraphqL type of the field. This attribute can sometimes be auto guess from Doctrine ORM annotations
+-   **type** : The GraphqL type of the field. This attribute can sometimes be guessed automatically from Doctrine ORM annotations
 -   **name** : The GraphQL name of the field (default to the property name). If you don't specify a `resolve` attribute while changing the `name`, the default one will be '@=value.<property_name>'
--   **args** : A array of `@Arg`
+-   **args** : An array of `@Arg`
 -   **resolve** : A resolution expression
 -   **fieldBuilder** : A field builder to use. Either as string (will be the field builder name), or as an array, first index will the name of the builder and second one will be the config.
 -   **argsBuilder** : An args builder to use. Either as string (will be the args builder name), or as an array, first index will the name of the builder and second one will be the config.
@@ -295,7 +292,6 @@ class Hero {
      */
     public $friends;
 }
-?>
 ```
 
 Example on methods:
@@ -318,7 +314,6 @@ class Hero {
         return array_slice($this->friends, 0, $limit);
     }
 }
-?>
 ```
 
 ## @FieldsBuilder
@@ -345,13 +340,12 @@ Example:
 class MyType {
 
 }
-?>
 ```
 
 ## @Input
 
 This annotation is used on a _class_ to define an input type.
-An Input type is pretty much the same as an input except:
+An Input type is pretty much the same as an input, except:
 
 -   Dynamic `@Field` with `resolve` attribute are ignored.
 
@@ -360,12 +354,12 @@ Optional attributes:
 -   **name** : The GraphQL name of the input field (default to classnameInput )
 -   **isRelay** : Set to true if you want your input to be relay compatible (ie. An extra field `clientMutationId` will be added to the input)
 
-The corresponding class will also be used by the `Arguments Transformer` service. A instance of the corresponding class will be use as the `input` value if it is an argument of a query or mutation. (see [The Arguments Transformer documentation](arguments-transformer.md)).
+The corresponding class will also be used by the `Arguments Transformer` service. An instance of the corresponding class will be use as the `input` value if it is an argument of a query or mutation. (see [The Arguments Transformer documentation](arguments-transformer.md)).
 
 ## @IsPublic
 
-Added on a _class_ in conjonction with `@Type` or `@TypeInterface`, this annotation will define the defaut to set if fields are public or not.
-Added on a _property_ or _method_ in conjonction with `@Field`, it'll define an expression to set if the field is public or not.
+Added on a _class_ in conjunction with `@Type` or `@TypeInterface`, this annotation will define the defaut to set if fields are public or not.
+Added on a _property_ or _method_ in conjunction with `@Field`, it'll define an expression to set if the field is public or not.
 
 Example:
 
@@ -383,18 +377,17 @@ class SecretArea {
      */
     public $secretCode;
 }
-?>
 ```
 
 ## @Mutation
 
-This annotation applies on methods for classes tagged with the `@Provider` annotation. It indicates that on this class a method will resolve a Mutation field.  
-The resulting field is added to the root Mutation type (define in configuration at key `overblog_graphql.definitions.schema.mutation`).  
-The class exposing the mutation(s) must have a corresponding service with his className.
+This annotation applies on methods for classes tagged with the `@Provider` annotation. It indicates that the method on this class will resolve a Mutation field.  
+The resulting field is added to the root Mutation type (defined in configuration at key `overblog_graphql.definitions.schema.mutation`).  
+The class exposing the mutation(s) must be declared as a [service](https://symfony.com/doc/current/service_container.html).
 
 Example:
 
-This will add a `updateUserEmail` mutation, with as resolver `@=service('App\Graphql\MutationProvider').updateUserEmail(...)`.
+This will add an `updateUserEmail` mutation, with as resolver `@=service('App\Graphql\MutationProvider').updateUserEmail(...)`.
 
 ```php
 <?php
@@ -420,14 +413,13 @@ class MutationProvider {
         return $user;
     }
 }
-?>
 ```
 
 ## @Provider
 
-This annotation applies on classes to indicate that it containts methods tagged with `@Query`o or `@Mutation`.  
+This annotation applies on classes to indicate that it contains methods tagged with `@Query` or `@Mutation`.  
 Without it, the `@Query` and `@Mutation` are ignored. When used, **remember to have a corresponding service with the fully qualified name of the class as service id**.  
-You can use `@Access` and/or `@IsPublic` on a provider class to add default access or visibility on query or mutation defined.  
+You can use `@Access` and/or `@IsPublic` on a provider class to add default access or visibility on defined query or mutation.  
 
 Optional attributes:
 
@@ -437,7 +429,7 @@ Optional attributes:
 
 This annotation applies on methods for classes tagged with the `@Provider` annotation. It indicates that on this class a method will resolve a Query field.  
 By default, the resulting field is added to the root Query type (define in configuration at key `overblog_graphql.definitions.schema.query`).  
-The class exposing the querie(s) must have a corresponding service with his className.
+The class exposing the query(ies) must be declared as a [service](https://symfony.com/doc/current/service_container.html).
 
 Optional attributes:
 
@@ -464,7 +456,6 @@ class UsersProviders {
         return $this->repository->findAll();
     }
 }
-?>
 ```
 
 ## @Type
@@ -474,7 +465,7 @@ This annotation is used on _class_ to define a GraphQL Type.
 Optional attributes:
 
 -   **name** : The GraphQL name of the type (default to the class name without namespace)
--   **interfaces** : An array of GraphQL interface this type herits from
+-   **interfaces** : An array of GraphQL interface this type inherits from
 -   **isRelay** : Set to true to have a Relay compatible type (ie. A `clientMutationId` will be added).
 -   **builders**: An array of `@FieldsBuilder` annotations
 
@@ -490,7 +481,6 @@ class Hero {
      */
     public $name;
 }
-?>
 ```
 
 ## @TypeInterface
@@ -680,4 +670,4 @@ class MyEdge {}
  * })
  */
 class MyEdge {}
-```
+```