Add xml documentation

README.md

@@ -3,6 +3,8 @@
 **master**<br/>[![Coverage Status](https://coveralls.io/repos/github/graphql-dotnet/parser/badge.svg?branch=master)](https://coveralls.io/github/graphql-dotnet/parser?branch=master)<br/>
 **develop**<br/>[![Coverage Status](https://coveralls.io/repos/github/graphql-dotnet/parser/badge.svg?branch=develop)](https://coveralls.io/github/graphql-dotnet/parser?branch=develop)<br/>
 
+<br/>
+
 [![NuGet](https://img.shields.io/nuget/v/GraphQL-Parser.svg)](https://www.nuget.org/packages/GraphQL-Parser)
 [![Nuget](https://img.shields.io/nuget/dt/GraphQL-Parser)](https://www.nuget.org/packages/GraphQL-Parser)
 

src/Directory.Build.props

@@ -20,7 +20,7 @@
     <!-- https://github.com/clairernovotny/DeterministicBuilds -->
     <ContinuousIntegrationBuild Condition="'$(GITHUB_ACTIONS)' == 'true'">True</ContinuousIntegrationBuild>
     <EnableNETAnalyzers>true</EnableNETAnalyzers>
-    <NoWarn>$(NoWarn);1591</NoWarn> <!--TODO: temporary solution-->
+    <NoWarn>$(NoWarn);1591</NoWarn> <!--TODO: temporary solution, remove-->
     <Nullable>enable</Nullable>
   </PropertyGroup>
 

src/GraphQLParser.ApiTests/GraphQL-Parser.approved.txt

@@ -73,7 +73,6 @@ namespace GraphQLParser.AST
     {
         public GraphQLDirectiveDefinition() { }
         public System.Collections.Generic.List<GraphQLParser.AST.GraphQLInputValueDefinition>? Arguments { get; set; }
-        public System.Collections.Generic.List<GraphQLParser.AST.GraphQLInputValueDefinition>? Definitions { get; set; }
         public override GraphQLParser.AST.ASTNodeKind Kind { get; }
         public System.Collections.Generic.List<GraphQLParser.AST.GraphQLName>? Locations { get; set; }
         public bool Repeatable { get; set; }

src/GraphQLParser.Benchmarks/GraphQLParser.Benchmarks.csproj

@@ -4,6 +4,7 @@
     <TargetFramework>net5</TargetFramework>
     <OutputType>Exe</OutputType>
     <IsPackable>false</IsPackable>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

src/GraphQLParser.Tests/GraphQLParser.Tests.csproj

@@ -3,6 +3,7 @@
   <PropertyGroup>
     <TargetFrameworks>net5;netcoreapp3.1</TargetFrameworks>
     <Nullable>disable</Nullable>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

src/GraphQLParser/AST/ASTNodeKind.cs

@@ -46,10 +46,20 @@ public enum ASTNodeKind
         ListValue,
         ObjectValue,
         ObjectField,
+
+        /// <summary>
+        /// Applied directive. Directives provide a way to describe alternate runtime execution
+        /// and type validation behavior in a GraphQL document. Directives can be used to describe
+        /// additional information for types, fields, fragments, operations, etc.
+        /// </summary>
         Directive,
         NamedType,
         ListType,
         NonNullType,
+
+        /// <summary>
+        /// Null values are represented as the keyword null.
+        /// </summary>
         NullValue,
         SchemaDefinition,
         OperationTypeDefinition,
@@ -63,6 +73,13 @@ public enum ASTNodeKind
         EnumValueDefinition,
         InputObjectTypeDefinition,
         TypeExtensionDefinition,
+
+
+        /// <summary>
+        /// Directive definition. Directives provide a way to describe alternate runtime execution
+        /// and type validation behavior in a GraphQL document. Directives can be used to describe
+        /// additional information for types, fields, fragments, operations, etc.
+        /// </summary>
         DirectiveDefinition,
 
         /// <summary>

src/GraphQLParser/AST/GraphQLArgument.cs

@@ -5,6 +5,7 @@ public class GraphQLArgument : ASTNode, INamedNode
         /// <inheritdoc/>
         public override ASTNodeKind Kind => ASTNodeKind.Argument;
 
+        /// <inheritdoc/>
         public GraphQLName? Name { get; set; }
 
         public GraphQLValue? Value { get; set; }
@@ -18,12 +19,12 @@ internal sealed class GraphQLArgumentFull : GraphQLArgument
         public override GraphQLLocation Location
         {
             get => _location;
-            set => _location = value; 
+            set => _location = value;
         }
 
         public override GraphQLComment? Comment
         {
-            get => _comment; 
+            get => _comment;
             set => _comment = value;
         }
     }

src/GraphQLParser/AST/GraphQLDirective.cs

@@ -2,13 +2,17 @@
 
 namespace GraphQLParser.AST
 {
+    /// <summary>
+    /// Represents a directive, applied to some GraphQL element.
+    /// </summary>
     public class GraphQLDirective : ASTNode, INamedNode
     {
         public List<GraphQLArgument>? Arguments { get; set; }
 
         /// <inheritdoc/>
         public override ASTNodeKind Kind => ASTNodeKind.Directive;
 
+        /// <inheritdoc/>
         public GraphQLName? Name { get; set; }
     }
 

src/GraphQLParser/AST/GraphQLDirectiveDefinition.cs

@@ -2,17 +2,29 @@
 
 namespace GraphQLParser.AST
 {
+    /// <summary>
+    /// Represents a directive definition.
+    /// </summary>
     public class GraphQLDirectiveDefinition : GraphQLTypeDefinition
     {
         public List<GraphQLInputValueDefinition>? Arguments { get; set; }
 
-        public List<GraphQLInputValueDefinition>? Definitions { get; set; }
-
         /// <inheritdoc/>
         public override ASTNodeKind Kind => ASTNodeKind.DirectiveDefinition;
 
+        /// <summary>
+        /// Returns a list of locations representing the valid locations this directive may be placed.
+        /// </summary>
         public List<GraphQLName>? Locations { get; set; }
 
+        /// <summary>
+        /// Indicates if the directive may be used repeatedly at a single location.
+        /// <br/><br/>
+        /// Repeatable directives are often useful when the same directive
+        /// should be used with different arguments at a single location,
+        /// especially in cases where additional information needs to be
+        /// provided to a type or schema extension via a directive
+        /// </summary>
         public bool Repeatable { get; set; }
     }
 

src/GraphQLParser/AST/GraphQLEnumTypeDefinition.cs

@@ -4,6 +4,7 @@ namespace GraphQLParser.AST
 {
     public class GraphQLEnumTypeDefinition : GraphQLTypeDefinition, IHasDirectivesNode
     {
+        /// <inheritdoc/>
         public List<GraphQLDirective>? Directives { get; set; }
 
         /// <inheritdoc/>

src/GraphQLParser/AST/GraphQLEnumValueDefinition.cs

@@ -4,6 +4,7 @@ namespace GraphQLParser.AST
 {
     public class GraphQLEnumValueDefinition : GraphQLTypeDefinition, IHasDirectivesNode
     {
+        /// <inheritdoc/>
         public List<GraphQLDirective>? Directives { get; set; }
 
         /// <inheritdoc/>

src/GraphQLParser/AST/GraphQLFieldDefinition.cs

@@ -6,6 +6,7 @@ public class GraphQLFieldDefinition : GraphQLTypeDefinition, IHasDirectivesNode
     {
         public List<GraphQLInputValueDefinition>? Arguments { get; set; }
 
+        /// <inheritdoc/>
         public List<GraphQLDirective>? Directives { get; set; }
 
         /// <inheritdoc/>

src/GraphQLParser/AST/GraphQLFieldSelection.cs

@@ -8,11 +8,13 @@ public class GraphQLFieldSelection : ASTNode, IHasDirectivesNode, INamedNode
 
         public List<GraphQLArgument>? Arguments { get; set; }
 
+        /// <inheritdoc/>
         public List<GraphQLDirective>? Directives { get; set; }
 
         /// <inheritdoc/>
         public override ASTNodeKind Kind => ASTNodeKind.Field;
 
+        /// <inheritdoc/>
         public GraphQLName? Name { get; set; }
 
         public GraphQLSelectionSet? SelectionSet { get; set; }

src/GraphQLParser/AST/GraphQLFragmentDefinition.cs

@@ -5,6 +5,7 @@ public class GraphQLFragmentDefinition : GraphQLInlineFragment, INamedNode
         /// <inheritdoc/>
         public override ASTNodeKind Kind => ASTNodeKind.FragmentDefinition;
 
+        /// <inheritdoc/>
         public GraphQLName? Name { get; set; }
     }
 

src/GraphQLParser/AST/GraphQLFragmentSpread.cs

@@ -4,11 +4,13 @@ namespace GraphQLParser.AST
 {
     public class GraphQLFragmentSpread : ASTNode, IHasDirectivesNode, INamedNode
     {
+        /// <inheritdoc/>
         public List<GraphQLDirective>? Directives { get; set; }
 
         /// <inheritdoc/>
         public override ASTNodeKind Kind => ASTNodeKind.FragmentSpread;
 
+        /// <inheritdoc/>
         public GraphQLName? Name { get; set; }
     }
 

src/GraphQLParser/AST/GraphQLInlineFragment.cs

@@ -4,6 +4,7 @@ namespace GraphQLParser.AST
 {
     public class GraphQLInlineFragment : ASTNode, IHasDirectivesNode
     {
+        /// <inheritdoc/>
         public List<GraphQLDirective>? Directives { get; set; }
 
         /// <inheritdoc/>

src/GraphQLParser/AST/GraphQLInputObjectTypeDefinition.cs

@@ -4,6 +4,7 @@ namespace GraphQLParser.AST
 {
     public class GraphQLInputObjectTypeDefinition : GraphQLTypeDefinition, IHasDirectivesNode
     {
+        /// <inheritdoc/>
         public List<GraphQLDirective>? Directives { get; set; }
 
         public List<GraphQLInputValueDefinition>? Fields { get; set; }

src/GraphQLParser/AST/GraphQLInputValueDefinition.cs

@@ -6,6 +6,7 @@ public class GraphQLInputValueDefinition : GraphQLTypeDefinition, IHasDirectives
     {
         public GraphQLValue? DefaultValue { get; set; }
 
+        /// <inheritdoc/>
         public List<GraphQLDirective>? Directives { get; set; }
 
         /// <inheritdoc/>

src/GraphQLParser/AST/GraphQLInterfaceTypeDefinition.cs

@@ -4,6 +4,7 @@ namespace GraphQLParser.AST
 {
     public class GraphQLInterfaceTypeDefinition : GraphQLTypeDefinition, IHasDirectivesNode
     {
+        /// <inheritdoc/>
         public List<GraphQLDirective>? Directives { get; set; }
 
         public List<GraphQLFieldDefinition>? Fields { get; set; }

src/GraphQLParser/AST/GraphQLNamedType.cs

@@ -5,6 +5,7 @@ public class GraphQLNamedType : GraphQLType, INamedNode
         /// <inheritdoc/>
         public override ASTNodeKind Kind => ASTNodeKind.NamedType;
 
+        /// <inheritdoc/>
         public GraphQLName? Name { get; set; }
 
         /// <inheritdoc/>

src/GraphQLParser/AST/GraphQLObjectField.cs

@@ -5,6 +5,7 @@ public class GraphQLObjectField : ASTNode, INamedNode
         /// <inheritdoc/>
         public override ASTNodeKind Kind => ASTNodeKind.ObjectField;
 
+        /// <inheritdoc/>
         public GraphQLName? Name { get; set; }
 
         public GraphQLValue? Value { get; set; }

src/GraphQLParser/AST/GraphQLObjectTypeDefinition.cs

@@ -4,6 +4,7 @@ namespace GraphQLParser.AST
 {
     public class GraphQLObjectTypeDefinition : GraphQLTypeDefinition, IHasDirectivesNode
     {
+        /// <inheritdoc/>
         public List<GraphQLDirective>? Directives { get; set; }
 
         public List<GraphQLFieldDefinition>? Fields { get; set; }

src/GraphQLParser/AST/GraphQLOperationDefinition.cs

@@ -4,11 +4,13 @@ namespace GraphQLParser.AST
 {
     public class GraphQLOperationDefinition : ASTNode, IHasDirectivesNode, INamedNode
     {
+        /// <inheritdoc/>
         public List<GraphQLDirective>? Directives { get; set; }
 
         /// <inheritdoc/>
         public override ASTNodeKind Kind => ASTNodeKind.OperationDefinition;
 
+        /// <inheritdoc/>
         public GraphQLName? Name { get; set; }
 
         public OperationType Operation { get; set; }

src/GraphQLParser/AST/GraphQLScalarTypeDefinition.cs

@@ -4,6 +4,7 @@ namespace GraphQLParser.AST
 {
     public class GraphQLScalarTypeDefinition : GraphQLTypeDefinition, IHasDirectivesNode
     {
+        /// <inheritdoc/>
         public List<GraphQLDirective>? Directives { get; set; }
 
         /// <inheritdoc/>

src/GraphQLParser/AST/GraphQLSchemaDefinition.cs

@@ -4,6 +4,7 @@ namespace GraphQLParser.AST
 {
     public class GraphQLSchemaDefinition : ASTNode, IHasDirectivesNode
     {
+        /// <inheritdoc/>
         public List<GraphQLDirective>? Directives { get; set; }
 
         /// <inheritdoc/>

src/GraphQLParser/AST/GraphQLTypeDefinition.cs

@@ -1,7 +1,8 @@
-namespace GraphQLParser.AST
+namespace GraphQLParser.AST
 {
     public abstract class GraphQLTypeDefinition : ASTNode, INamedNode
     {
+        /// <inheritdoc/>
         public GraphQLName? Name { get; set; }
     }
-}
+}

src/GraphQLParser/AST/GraphQLUnionTypeDefinition.cs

@@ -4,6 +4,7 @@ namespace GraphQLParser.AST
 {
     public class GraphQLUnionTypeDefinition : GraphQLTypeDefinition, IHasDirectivesNode
     {
+        /// <inheritdoc/>
         public List<GraphQLDirective>? Directives { get; set; }
 
         /// <inheritdoc/>

src/GraphQLParser/AST/GraphQLVariable.cs

@@ -5,6 +5,7 @@ public class GraphQLVariable : GraphQLValue, INamedNode
         /// <inheritdoc/>
         public override ASTNodeKind Kind => ASTNodeKind.Variable;
 
+        /// <inheritdoc/>
         public GraphQLName? Name { get; set; }
     }
 

src/GraphQLParser/AST/IHasDirectivesNode.cs

@@ -1,9 +1,15 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 
 namespace GraphQLParser.AST
 {
+    /// <summary>
+    /// Represents an AST node that may have directives applied to it (type, argument, field, enum, etc.).
+    /// </summary>
     public interface IHasDirectivesNode
     {
+        /// <summary>
+        /// Directives of the node represented as a list of nested nodes.
+        /// </summary>
         List<GraphQLDirective>? Directives { get; set; }
     }
 }

src/GraphQLParser/AST/INamedNode.cs

@@ -1,7 +1,13 @@
-namespace GraphQLParser.AST
+namespace GraphQLParser.AST
 {
+    /// <summary>
+    /// Represents an AST node that has a name (type, argument, directive, field, operation, variable, etc.).
+    /// </summary>
     public interface INamedNode
     {
+        /// <summary>
+        /// Name of the node represented as a nested node.
+        /// </summary>
         GraphQLName? Name { get; set; }
     }
 }