Merge pull request #175 from octokit/add-input-object-comments

Add doc comments to input objects

Author: grokys

Octokit.GraphQL.Core.Generation.UnitTests/InputObjectGenerationTests.cs

@@ -66,6 +66,31 @@ public void Generates_Property_For_List_Field()
             CompareModel("InputObject.cs", expected, result);
         }
 
+        [Fact]
+        public void Generates_Property_For_List_Field_With_Description()
+        {
+            var expected = FormatMemberTemplate("/// <summary>\r\n        /// Field foo for InputObject\r\n        /// </summary>\r\n        public IEnumerable<int?> Foo { get; set; }");
+
+            var model = new TypeModel
+            {
+                Name = "InputObject",
+                Kind = TypeKind.InputObject,
+                InputFields = new[]
+                {
+                    new InputValueModel
+                    {
+                        Description = "Field foo for InputObject",
+                        Name = "foo",
+                        Type = TypeModel.List(TypeModel.Int())
+                    },
+                }
+            };
+
+            var result = CodeGenerator.Generate(model, "Test", null);
+
+            CompareModel("InputObject.cs", expected, result);
+        }
+
         private string FormatMemberTemplate(string members)
         {
             if (members != null)

Octokit.GraphQL.Core.Generation/InputObjectGenerator.cs

@@ -52,9 +52,10 @@ private static string GenerateFields(TypeModel type)
 
         private static string GenerateField(InputValueModel field)
         {
+            var result = GenerateDocComments(field);
             var name = TypeUtilities.PascalCase(field.Name);
             var typeName = TypeUtilities.GetCSharpArgType(field.Type);
-            return $"        public {typeName} {name} {{ get; set; }}";
+            return result + $"        public {typeName} {name} {{ get; set; }}";
         }
 
         private static string GenerateDocComments(TypeModel type)
@@ -72,24 +73,12 @@ private static string GenerateDocComments(TypeModel type)
             }
         }
 
-        private static string GenerateDocComments(FieldModel field)
+        private static string GenerateDocComments(InputValueModel field)
         {
             if (!string.IsNullOrWhiteSpace(field.Description))
             {
                 var builder = new StringBuilder();
                 DocCommentGenerator.GenerateSummary(field.Description, 8, builder);
-
-                if (field.Args != null)
-                {
-                    foreach (var arg in field.Args)
-                    {
-                        if (!string.IsNullOrWhiteSpace(arg.Description))
-                        {
-                            builder.AppendLine($"        /// <param name=\"{arg.Name}\">{arg.Description}</param>");
-                        }
-                    }
-                }
-
                 return builder.ToString();
             }
             else

Octokit.GraphQL/Model/AcceptTopicSuggestionInput.cs

@@ -8,10 +8,19 @@ namespace Octokit.GraphQL.Model
     /// </summary>
     public class AcceptTopicSuggestionInput
     {
+        /// <summary>
+        /// The Node ID of the repository.
+        /// </summary>
         public ID RepositoryId { get; set; }
 
+        /// <summary>
+        /// The name of the suggested topic.
+        /// </summary>
         public string Name { get; set; }
 
+        /// <summary>
+        /// A unique identifier for the client performing the mutation.
+        /// </summary>
         public string ClientMutationId { get; set; }
     }
 }

Octokit.GraphQL/Model/AddCommentInput.cs

@@ -8,10 +8,19 @@ namespace Octokit.GraphQL.Model
     /// </summary>
     public class AddCommentInput
     {
+        /// <summary>
+        /// The Node ID of the subject to modify.
+        /// </summary>
         public ID SubjectId { get; set; }
 
+        /// <summary>
+        /// The contents of the comment.
+        /// </summary>
         public string Body { get; set; }
 
+        /// <summary>
+        /// A unique identifier for the client performing the mutation.
+        /// </summary>
         public string ClientMutationId { get; set; }
     }
 }

Octokit.GraphQL/Model/AddProjectCardInput.cs

@@ -8,12 +8,24 @@ namespace Octokit.GraphQL.Model
     /// </summary>
     public class AddProjectCardInput
     {
+        /// <summary>
+        /// The Node ID of the ProjectColumn.
+        /// </summary>
         public ID ProjectColumnId { get; set; }
 
+        /// <summary>
+        /// The content of the card. Must be a member of the ProjectCardItem union
+        /// </summary>
         public ID? ContentId { get; set; }
 
+        /// <summary>
+        /// The note on the card.
+        /// </summary>
         public string Note { get; set; }
 
+        /// <summary>
+        /// A unique identifier for the client performing the mutation.
+        /// </summary>
         public string ClientMutationId { get; set; }
     }
 }

Octokit.GraphQL/Model/AddProjectColumnInput.cs

@@ -8,10 +8,19 @@ namespace Octokit.GraphQL.Model
     /// </summary>
     public class AddProjectColumnInput
     {
+        /// <summary>
+        /// The Node ID of the project.
+        /// </summary>
         public ID ProjectId { get; set; }
 
+        /// <summary>
+        /// The name of the column.
+        /// </summary>
         public string Name { get; set; }
 
+        /// <summary>
+        /// A unique identifier for the client performing the mutation.
+        /// </summary>
         public string ClientMutationId { get; set; }
     }
 }

Octokit.GraphQL/Model/AddPullRequestReviewCommentInput.cs

@@ -8,18 +8,39 @@ namespace Octokit.GraphQL.Model
     /// </summary>
     public class AddPullRequestReviewCommentInput
     {
+        /// <summary>
+        /// The Node ID of the review to modify.
+        /// </summary>
         public ID PullRequestReviewId { get; set; }
 
+        /// <summary>
+        /// The SHA of the commit to comment on.
+        /// </summary>
         public string CommitOID { get; set; }
 
+        /// <summary>
+        /// The text of the comment.
+        /// </summary>
         public string Body { get; set; }
 
+        /// <summary>
+        /// The relative path of the file to comment on.
+        /// </summary>
         public string Path { get; set; }
 
+        /// <summary>
+        /// The line index in the diff to comment on.
+        /// </summary>
         public int? Position { get; set; }
 
+        /// <summary>
+        /// The comment id to reply to.
+        /// </summary>
         public ID? InReplyTo { get; set; }
 
+        /// <summary>
+        /// A unique identifier for the client performing the mutation.
+        /// </summary>
         public string ClientMutationId { get; set; }
     }
 }

Octokit.GraphQL/Model/AddPullRequestReviewInput.cs

@@ -8,16 +8,34 @@ namespace Octokit.GraphQL.Model
     /// </summary>
     public class AddPullRequestReviewInput
     {
+        /// <summary>
+        /// The Node ID of the pull request to modify.
+        /// </summary>
         public ID PullRequestId { get; set; }
 
+        /// <summary>
+        /// The commit OID the review pertains to.
+        /// </summary>
         public string CommitOID { get; set; }
 
+        /// <summary>
+        /// The contents of the review body comment.
+        /// </summary>
         public string Body { get; set; }
 
+        /// <summary>
+        /// The event to perform on the pull request review.
+        /// </summary>
         public PullRequestReviewEvent? Event { get; set; }
 
+        /// <summary>
+        /// The review line comments.
+        /// </summary>
         public IEnumerable<DraftPullRequestReviewComment> Comments { get; set; }
 
+        /// <summary>
+        /// A unique identifier for the client performing the mutation.
+        /// </summary>
         public string ClientMutationId { get; set; }
     }
 }

Octokit.GraphQL/Model/AddReactionInput.cs

@@ -8,10 +8,19 @@ namespace Octokit.GraphQL.Model
     /// </summary>
     public class AddReactionInput
     {
+        /// <summary>
+        /// The Node ID of the subject to modify.
+        /// </summary>
         public ID SubjectId { get; set; }
 
+        /// <summary>
+        /// The name of the emoji to react with.
+        /// </summary>
         public ReactionContent Content { get; set; }
 
+        /// <summary>
+        /// A unique identifier for the client performing the mutation.
+        /// </summary>
         public string ClientMutationId { get; set; }
     }
 }

Octokit.GraphQL/Model/AddStarInput.cs

@@ -8,8 +8,14 @@ namespace Octokit.GraphQL.Model
     /// </summary>
     public class AddStarInput
     {
+        /// <summary>
+        /// The Starrable ID to star.
+        /// </summary>
         public ID StarrableId { get; set; }
 
+        /// <summary>
+        /// A unique identifier for the client performing the mutation.
+        /// </summary>
         public string ClientMutationId { get; set; }
     }
 }