Fix cshardocs multi-line regression

RicoSuter · Dec 14, 2021 · 9b8505a · 9b8505a
1 parent 76afab6
commit 9b8505a
Show file tree

Hide file tree

Showing 4 changed files with 72 additions and 17 deletions.
diff --git a/src/NJsonSchema.CodeGeneration.CSharp.Tests/GeneralGeneratorTests.cs b/src/NJsonSchema.CodeGeneration.CSharp.Tests/GeneralGeneratorTests.cs
@@ -293,7 +293,11 @@ public async Task When_enum_has_description_then_csharp_has_xml_comment()
             var output = generator.GenerateFile("MyClass");
 
             //// Assert
-            Assert.Contains(@"/// <summary>EnumDesc.</summary>", output);
+            var summary = @"
+        /// <summary>
+        /// EnumDesc.
+        /// </summary>".Replace("\r", "").Trim();
+            Assert.Contains(summary, output);
 
             AssertCompile(output);
         }
@@ -310,7 +314,11 @@ public async Task When_class_has_description_then_csharp_has_xml_comment()
             var output = generator.GenerateFile("MyClass");
 
             //// Assert
-            Assert.Contains(@"/// <summary>ClassDesc.</summary>", output);
+            var summary = @"
+    /// <summary>
+    /// ClassDesc.
+    /// </summary>".Replace("\r", "");
+            Assert.Contains(summary, output);
 
             AssertCompile(output);
         }
@@ -327,7 +335,11 @@ public async Task When_property_has_description_then_csharp_has_xml_comment()
             var output = generator.GenerateFile("MyClass");
 
             //// Assert
-            Assert.Contains(@"/// <summary>PropertyDesc.</summary>", output);
+            var summary = @"
+        /// <summary>
+        /// PropertyDesc.
+        /// </summary>".Replace("\r", "").Trim();
+            Assert.Contains(summary, output);
 
             AssertCompile(output);
         }
@@ -1980,5 +1992,48 @@ public static Person FromJson(string data)
 
             AssertCompile(output);
         }
+
+        public class DocumentationTest
+        {
+            /// <summary>
+            /// Summary is here
+            ///
+            /// spanning multiple lines
+            ///
+            /// like this.
+            ///
+            /// </summary>
+            public string HelloMessage { get; set; }
+        }
+
+        [Fact]
+        public async Task When_documentation_present_produces_valid_xml_documentation_syntax()
+        {
+            // Arrange
+            var schema = JsonSchema.FromType<DocumentationTest>();
+
+            // Act
+            var generator = new CSharpGenerator(schema, new CSharpGeneratorSettings
+            {
+                ClassStyle = CSharpClassStyle.Poco
+            });
+
+            var code = generator.GenerateFile("MyClass");
+
+            // Assert
+            var expected = @"
+        /// <summary>
+        /// Summary is here
+        /// <br/>            
+        /// <br/>spanning multiple lines
+        /// <br/>            
+        /// <br/>like this.
+        /// <br/>            
+        /// </summary>".Replace("\r","");
+
+            Assert.Contains(expected, code);
+
+            AssertCompile(code);
+        }
     }
 }
diff --git a/src/NJsonSchema.CodeGeneration.CSharp/Templates/Class.liquid b/src/NJsonSchema.CodeGeneration.CSharp/Templates/Class.liquid
@@ -1,5 +1,7 @@
 {%- if HasDescription -%}
-/// <summary>{{ Description | csharpdocs }}</summary>
+/// <summary>
+/// {{ Description | csharpdocs }}
+/// </summary>
 {%- endif -%}
 {%- if HasDiscriminator -%}
 {%- if UseSystemTextJson -%}
@@ -45,7 +47,9 @@
 {%- endif -%}
 {%- for property in Properties -%}
 {%-   if property.HasDescription -%}
-    /// <summary>{{ property.Description | csharpdocs }}</summary>
+    /// <summary>
+    /// {{ property.Description | csharpdocs }}
+    /// </summary>
 {%-   endif -%}
 {%- if UseSystemTextJson %}
     [System.Text.Json.Serialization.JsonPropertyName("{{ property.Name }}")]

diff --git a/src/NJsonSchema.CodeGeneration.CSharp/Templates/Enum.liquid b/src/NJsonSchema.CodeGeneration.CSharp/Templates/Enum.liquid
@@ -1,5 +1,7 @@
 {%- if HasDescription -%}
-/// <summary>{{ Description | csharpdocs }}</summary>
+/// <summary>
+/// {{ Description | csharpdocs }}
+/// </summary>
 {%- endif -%}
 [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "{{ ToolchainVersion }}")]
 {%- if IsEnumAsBitFlags -%}

diff --git a/src/NJsonSchema/ConversionUtilities.cs b/src/NJsonSchema/ConversionUtilities.cs
@@ -270,19 +270,13 @@ private static void AddPrefixToBeginningOfNonEmptyLines(string input, string tab
         /// <returns>The output.</returns>
         public static string ConvertCSharpDocs(string input, int tabCount)
         {
-            if (input is null)
-            {
-                return "";
-            }
-            var tabString = CreateTabString(tabCount);
-            input = input
-                .Replace("\r", string.Empty);
-
-            var stringWriter = new StringWriter(new StringBuilder(input.Length), CultureInfo.CurrentCulture);
-            AddPrefixToBeginningOfNonEmptyLines(input, tabString + "/// ", stringWriter);
+            input = input?
+                        .Replace("\r", string.Empty)
+                        .Replace("\n", "\n" + string.Join("", Enumerable.Repeat("    ", tabCount)) + "/// ")
+                    ?? string.Empty;
 
             // TODO: Support more markdown features here
-            var xml = new XText(stringWriter.ToString()).ToString();
+            var xml = new XText(input).ToString();
             return Regex.Replace(xml, @"^( *)/// ", m => m.Groups[1] + "/// <br/>", RegexOptions.Multiline);
         }