Skip to content

Commit

Permalink
Merge pull request #1062 from akshita31/typelookup_v2
Browse files Browse the repository at this point in the history 
Typelookup clean up and add objects for parameters and similar symbols
  • Loading branch information
Ravi Chande authored Dec 14, 2017
2 parents 10a2f0e + 516971f commit d358e11
Show file tree
Hide file tree
Showing 3 changed files with 101 additions and 76 deletions.
69 changes: 43 additions & 26 deletions src/OmniSharp.Abstractions/Models/v1/TypeLookup/DocumentationComment.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ namespace OmniSharp.Models.TypeLookup
public class DocumentationComment
{
public string SummaryText { get; }
public string[] TypeParamElements { get; }
public string[] ParamElements { get; }
public DocumentationItem[] TypeParamElements { get; }
public DocumentationItem[] ParamElements { get; }
public string ReturnsText { get; }
public string RemarksText { get; }
public string ExampleText { get; }
public string ValueText { get; }
public string[ ] Exception { get; }
public DocumentationItem[] Exception { get; }

private DocumentationComment(string summaryText, string[] typeParamElements, string[] paramElements, string returnsText, string remarksText, string exampleText, string valueText, string [ ] exception)
private DocumentationComment(string summaryText, DocumentationItem[] typeParamElements, DocumentationItem[] paramElements, string returnsText, string remarksText, string exampleText, string valueText, DocumentationItem[ ] exception)
{
SummaryText = summaryText;
TypeParamElements = typeParamElements;
Expand All @@ -34,13 +34,13 @@ public static DocumentationComment From(string xmlDocumentation, string lineEndi
{
var reader = new StringReader("<docroot>" + xmlDocumentation + "</docroot>");
StringBuilder summaryText = new StringBuilder();
List<StringBuilder> typeParamElements = new List<StringBuilder>();
List<StringBuilder> paramElements = new List<StringBuilder>();
List<DocumentationItemBuilder> typeParamElements = new List<DocumentationItemBuilder>();
List<DocumentationItemBuilder> paramElements = new List<DocumentationItemBuilder>();
StringBuilder returnsText = new StringBuilder();
StringBuilder remarksText = new StringBuilder();
StringBuilder exampleText = new StringBuilder();
StringBuilder valueText = new StringBuilder();
List<StringBuilder> exception = new List<StringBuilder>();
List<DocumentationItemBuilder> exception = new List<DocumentationItemBuilder>();

using (var xml = XmlReader.Create(reader))
{
Expand All @@ -60,26 +60,21 @@ public static DocumentationComment From(string xmlDocumentation, string lineEndi
xml.Skip();
break;
case "remarks":
remarksText.Append("Remarks: ");
currentSectionBuilder = remarksText;
break;
case "example":
exampleText.Append("Example: ");
currentSectionBuilder = exampleText;
break;
case "exception":
StringBuilder ExceptionInstance = new StringBuilder();
ExceptionInstance.Append(GetCref(xml["cref"]).TrimEnd());
ExceptionInstance.Append(": ");
currentSectionBuilder = ExceptionInstance;
exception.Add(ExceptionInstance);
DocumentationItemBuilder exceptionInstance = new DocumentationItemBuilder();
exceptionInstance.Name = GetCref(xml["cref"]).TrimEnd();
currentSectionBuilder = exceptionInstance.Documentation;
exception.Add(exceptionInstance);
break;
case "returns":
returnsText.Append("Returns: ");
currentSectionBuilder = returnsText;
break;
case "summary":
summaryText.Append("Summary: ");
currentSectionBuilder = summaryText;
break;
case "see":
Expand All @@ -95,25 +90,22 @@ public static DocumentationComment From(string xmlDocumentation, string lineEndi
currentSectionBuilder.Append(" ");
break;
case "param":
StringBuilder paramInstance = new StringBuilder();
paramInstance.Append(TrimMultiLineString(xml["name"], lineEnding));
paramInstance.Append(": ");
currentSectionBuilder = paramInstance;
DocumentationItemBuilder paramInstance = new DocumentationItemBuilder();
paramInstance.Name = TrimMultiLineString(xml["name"], lineEnding);
currentSectionBuilder = paramInstance.Documentation;
paramElements.Add(paramInstance);
break;
case "typeparamref":
currentSectionBuilder.Append(xml["name"]);
currentSectionBuilder.Append(" ");
break;
case "typeparam":
StringBuilder typeParamInstance = new StringBuilder();
typeParamInstance.Append(TrimMultiLineString(xml["name"], lineEnding));
typeParamInstance.Append(": ");
currentSectionBuilder = typeParamInstance;
DocumentationItemBuilder typeParamInstance = new DocumentationItemBuilder();
typeParamInstance.Name = TrimMultiLineString(xml["name"], lineEnding);
currentSectionBuilder = typeParamInstance.Documentation;
typeParamElements.Add(typeParamInstance);
break;
case "value":
valueText.Append("Value: ");
currentSectionBuilder = valueText;
break;
case "br":
Expand All @@ -140,7 +132,16 @@ public static DocumentationComment From(string xmlDocumentation, string lineEndi
return null;
}
}
return new DocumentationComment(summaryText.ToString(), typeParamElements.Select(s => s.ToString()).ToArray(), paramElements.Select(s => s.ToString()).ToArray(), returnsText.ToString(), remarksText.ToString(), exampleText.ToString(), valueText.ToString(), exception.Select(s => s.ToString()).ToArray());

return new DocumentationComment(
summaryText.ToString(),
typeParamElements.Select(s => s.ConvertToDocumentedObject()).ToArray(),
paramElements.Select(s => s.ConvertToDocumentedObject()).ToArray(),
returnsText.ToString(),
remarksText.ToString(),
exampleText.ToString(),
valueText.ToString(),
exception.Select(s => s.ConvertToDocumentedObject()).ToArray());
}

private static string TrimMultiLineString(string input, string lineEnding)
Expand All @@ -166,4 +167,20 @@ private static string GetCref(string cref)
return cref + " ";
}
}

class DocumentationItemBuilder
{
public string Name { get; set; }
public StringBuilder Documentation { get; set; }

public DocumentationItemBuilder()
{
Documentation = new StringBuilder();
}

public DocumentationItem ConvertToDocumentedObject()
{
return new DocumentationItem(Name, Documentation.ToString());
}
}
}
19 changes: 19 additions & 0 deletions src/OmniSharp.Abstractions/Models/v1/TypeLookup/DocumentationItem.cs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace OmniSharp.Models.TypeLookup
{
public class DocumentationItem
{
public string Name { get; }
public string Documentation { get; }
public DocumentationItem(string name, string documentation)
{
Name = name;
Documentation = documentation;
}
}
}
89 changes: 39 additions & 50 deletions tests/OmniSharp.Roslyn.CSharp.Tests/TypeLookupFacts.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ class testissue
}";
var response = await GetTypeLookUpResponse(content);
var expected =
@"Remarks: You may have some additional information about this class here.";
@"You may have some additional information about this class here.";
Assert.Equal(expected, response.StructuredDocumentation.RemarksText);
}

Expand All @@ -310,7 +310,7 @@ class testissue
}";
var response = await GetTypeLookUpResponse(content);
var expected =
@"Summary: Checks if object is tagged with the tag.";
@"Checks if object is tagged with the tag.";
Assert.Equal(expected, response.StructuredDocumentation.SummaryText);
}

Expand All @@ -327,7 +327,7 @@ class testissue
}";
var response = await GetTypeLookUpResponse(content);
var expected =
@"Returns: Returns true if object is tagged with tag.";
@"Returns true if object is tagged with tag.";
Assert.Equal(expected, response.StructuredDocumentation.ReturnsText);
}

Expand All @@ -344,7 +344,7 @@ class testissue
}";
var response = await GetTypeLookUpResponse(content);
var expected =
@"Example: Checks if object is tagged with the tag.";
@"Checks if object is tagged with the tag.";
Assert.Equal(expected, response.StructuredDocumentation.ExampleText);
}

Expand All @@ -363,12 +363,10 @@ class testissue
var response = await GetTypeLookUpResponse(content);
Assert.Equal(2, response.StructuredDocumentation.Exception.Count());

var expectedException0 =
@"A: A description";
Assert.Equal(expectedException0, response.StructuredDocumentation.Exception[0]);
var expectedException1 =
@"B: B description";
Assert.Equal(expectedException1, response.StructuredDocumentation.Exception[1]);
Assert.Equal("A", response.StructuredDocumentation.Exception[0].Name);
Assert.Equal("A description", response.StructuredDocumentation.Exception[0].Documentation);
Assert.Equal("B", response.StructuredDocumentation.Exception[1].Name);
Assert.Equal("B description", response.StructuredDocumentation.Exception[1].Documentation);
}

[Fact]
Expand All @@ -386,12 +384,10 @@ class testissue
var response = await GetTypeLookUpResponse(content);
Assert.Equal(2, response.StructuredDocumentation.ParamElements.Length);

var expectedParam0 =
@"gameObject: The game object.";
Assert.Equal(expectedParam0, response.StructuredDocumentation.ParamElements[0]);
var expectedParam1 =
@"tagName: Name of the tag.";
Assert.Equal(expectedParam1, response.StructuredDocumentation.ParamElements[1]);
Assert.Equal("gameObject", response.StructuredDocumentation.ParamElements[0].Name);
Assert.Equal("The game object.", response.StructuredDocumentation.ParamElements[0].Documentation);
Assert.Equal("tagName", response.StructuredDocumentation.ParamElements[1].Name);
Assert.Equal("Name of the tag.", response.StructuredDocumentation.ParamElements[1].Documentation);
}

[Fact]
Expand All @@ -413,12 +409,10 @@ public class TestClass
var response = await GetTypeLookUpResponse(content);
Assert.Equal(2, response.StructuredDocumentation.TypeParamElements.Count());

var expected0 =
@"T: The element type of the array";
Assert.Equal(expected0, response.StructuredDocumentation.TypeParamElements[0]);
var expected1 =
@"X: The element type of the list";
Assert.Equal(expected1, response.StructuredDocumentation.TypeParamElements[1]);
Assert.Equal("T", response.StructuredDocumentation.TypeParamElements[0].Name);
Assert.Equal("The element type of the array", response.StructuredDocumentation.TypeParamElements[0].Documentation);
Assert.Equal("X", response.StructuredDocumentation.TypeParamElements[1].Name);
Assert.Equal("The element type of the list", response.StructuredDocumentation.TypeParamElements[1].Documentation);
}

[Fact]
Expand All @@ -438,10 +432,10 @@ public string Na$$me
";
var response = await GetTypeLookUpResponse(content);
var expectedValue =
@"Value: The Name property gets/sets the value of the string field, _name.";
@"The Name property gets/sets the value of the string field, _name.";
Assert.Equal(expectedValue, response.StructuredDocumentation.ValueText);
var expectedSummary =
@"Summary: The Name property represents the employee's name.";
@"The Name property represents the employee's name.";
Assert.Equal(expectedSummary, response.StructuredDocumentation.SummaryText);
}

Expand All @@ -458,7 +452,7 @@ public class TestClass
}";
var response = await GetTypeLookUpResponse(content);
var expected =
@"Summary: DoWork is a method in the TestClass class. System.Console.WriteLine(System.String) for information about output statements.";
@"DoWork is a method in the TestClass class. System.Console.WriteLine(System.String) for information about output statements.";
Assert.Equal(expected, response.StructuredDocumentation.SummaryText);
}

Expand All @@ -477,7 +471,7 @@ public class TestClass
}";
var response = await GetTypeLookUpResponse(content);
var expected =
@"Summary: Creates a new array of arbitrary type T ";
@"Creates a new array of arbitrary type T ";
Assert.Equal(expected, response.StructuredDocumentation.SummaryText);
}

Expand Down Expand Up @@ -505,7 +499,7 @@ public class TestClass
}";
var response = await GetTypeLookUpResponse(content);
var expected =
@"Example: This sample shows how to call the TestClass.GetZero method.
@"This sample shows how to call the TestClass.GetZero method.
class TestClass
{
Expand Down Expand Up @@ -534,7 +528,7 @@ public class TestClass
";
var response = await GetTypeLookUpResponse(content);
var expected =
@"Summary: DoWork is a method in the TestClass class.
@"DoWork is a method in the TestClass class.
Here's how you could make a second paragraph in a description.";
Assert.Equal(expected.Replace("\r", ""), response.StructuredDocumentation.SummaryText);
Expand All @@ -559,7 +553,7 @@ static void Main()
}";
var response = await GetTypeLookUpResponse(content);
var expected =
@"Summary: DoWork is a method in the TestClass class.
@"DoWork is a method in the TestClass class.
See also: TestClass.Main ";
Assert.Equal(expected.Replace("\r", ""), response.StructuredDocumentation.SummaryText);
}
Expand All @@ -579,16 +573,14 @@ class testissue
}";
var response = await GetTypeLookUpResponse(content);
var expected =
@"Summary: Checks if object is tagged with the tag.";
@"Checks if object is tagged with the tag.";
Assert.Equal(expected, response.StructuredDocumentation.SummaryText);

Assert.Equal(2, response.StructuredDocumentation.ParamElements.Length);
var expectedParam0 =
@"gameObject: The game object.";
Assert.Equal(expectedParam0, response.StructuredDocumentation.ParamElements[0]);
var expectedParam1 =
@"tagName: Name of the tag.";
Assert.Equal(expectedParam1, response.StructuredDocumentation.ParamElements[1]);
Assert.Equal("gameObject", response.StructuredDocumentation.ParamElements[0].Name);
Assert.Equal("The game object.", response.StructuredDocumentation.ParamElements[0].Documentation);
Assert.Equal("tagName", response.StructuredDocumentation.ParamElements[1].Name);
Assert.Equal("Name of the tag.", response.StructuredDocumentation.ParamElements[1].Documentation);
}

[Fact]
Expand All @@ -610,34 +602,31 @@ class testissue
}";
var response = await GetTypeLookUpResponse(content);
var expectedSummary =
@"Summary: Checks if object is tagged with the tag.";
@"Checks if object is tagged with the tag.";
Assert.Equal(expectedSummary, response.StructuredDocumentation.SummaryText);

Assert.Single(response.StructuredDocumentation.ParamElements);
var expectedParam =
@"gameObject: The game object.";
Assert.Equal(expectedParam, response.StructuredDocumentation.ParamElements[0]);

Assert.Equal("gameObject", response.StructuredDocumentation.ParamElements[0].Name);
Assert.Equal("The game object.", response.StructuredDocumentation.ParamElements[0].Documentation);

var expectedExample =
@"Example: Invoke using A.Compare(5) where A is an instance of the class testissue.";
@"Invoke using A.Compare(5) where A is an instance of the class testissue.";
Assert.Equal(expectedExample, response.StructuredDocumentation.ExampleText);

Assert.Single(response.StructuredDocumentation.TypeParamElements);
var expectedTypeParam =
@"T: The element type of the array";
Assert.Equal(expectedTypeParam, response.StructuredDocumentation.TypeParamElements[0]);
Assert.Equal("T", response.StructuredDocumentation.TypeParamElements[0].Name);
Assert.Equal("The element type of the array", response.StructuredDocumentation.TypeParamElements[0].Documentation);

Assert.Single(response.StructuredDocumentation.Exception);
var expectedException =
@"System.Exception: Thrown when something goes wrong";
Assert.Equal(expectedException, response.StructuredDocumentation.Exception[0]);
Assert.Equal("System.Exception", response.StructuredDocumentation.Exception[0].Name);
Assert.Equal("Thrown when something goes wrong", response.StructuredDocumentation.Exception[0].Documentation);

var expectedRemarks =
@"Remarks: You may have some additional information about this class here.";
@"You may have some additional information about this class here.";
Assert.Equal(expectedRemarks, response.StructuredDocumentation.RemarksText);

var expectedReturns =
@"Returns: Returns an array of type T .";
@"Returns an array of type T .";
Assert.Equal(expectedReturns, response.StructuredDocumentation.ReturnsText);
}
}
Expand Down

0 comments on commit d358e11

Please sign in to comment.