VS Code Issue 1057 - Problem with Newlines in displaying XML Documentation

src/OmniSharp.Roslyn.CSharp/Services/Types/TypeLookup.cs

@@ -1,4 +1,5 @@
-using System.Composition;
+using System;
+using System.Composition;
 using System.Threading.Tasks;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.FindSymbols;
@@ -45,7 +46,9 @@ public async Task<TypeLookupResponse> Handle(TypeLookupRequest request)
 
                     if (request.IncludeDocumentation)
                     {
-                        response.Documentation = DocumentationConverter.ConvertDocumentation(symbol.GetDocumentationCommentXml(), _formattingOptions.NewLine);
+                        string newLine = Environment.NewLine + Environment.NewLine;
+                        //VS Code renders a single new line for two newline sequences in the response, hence two new lines are passed in the lineEnding parameter 
+                        response.Documentation = DocumentationConverter.ConvertDocumentation(symbol.GetDocumentationCommentXml(),newLine);
                     }
                 }
             }

tests/OmniSharp.Roslyn.CSharp.Tests/TypeLookupFacts.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Threading.Tasks;
 using OmniSharp.Models.TypeLookup;
 using OmniSharp.Options;
@@ -242,5 +243,42 @@ public async Task DisplayFormatFor_PropertySymbol_WithGenerics()
             var response = await GetTypeLookUpResponse(line: 15, column: 70);
             Assert.Equal("IDictionary<string, IEnumerable<int>> Foo.SomeDict", response.Type);
         }
+
+        [Fact]
+        public async Task CheckParsedXMLDocumentation()
+        {
+            string source =
+@"using System;
+namespace class1
+{
+    class testissue
+    {
+        ///<summary>
+/// Checks if object is tagged with the tag</summary>
+/// <param name=""gameObject"">The game object.</param> 
+/// <param name=""tagName"">Name of the tag.</param>
+/// <returns>Returns <c> true</c>if object is tagged with tag.</returns>
+        public static bool Compare(int gameObject, string tagName)
+            {
+                return gameObject.TagifyCompareTag(tagName);
+            }
+            ";
+            var testFile = new TestFile("dummy.cs", source);
+            using (var host = CreateOmniSharpHost(testFile))
+            {
+                var requestHandler = GetRequestHandler(host);
+
+                var request = new TypeLookupRequest { FileName = testFile.FileName, Line = 10, Column = 31, IncludeDocumentation=true };
+                var response = await requestHandler.Handle(request);
+                var expected =
+@"Checks if object is tagged with the tag
+gameObject: The game object.
+tagName: Name of the tag.
+Returns: Returns trueif object is tagged with tag.";
+                string lineEnding = Environment.NewLine;
+                //To remove the extra new lines added for VS Code for comparison, Replace function is being used
+                Assert.Equal(expected, response.Documentation.Replace(lineEnding + lineEnding, lineEnding));
+            }
+        }
     }
 }