/// <inheritdoc/>
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentWithoutSummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
</ClassName>
";
resolver.XmlReferences.Add("ClassWithoutSummary.xml", contentWithoutSummary);
string contentWithSummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<summary>
Foo
</summary>
</ClassName>
";
resolver.XmlReferences.Add("ClassWithSummary.xml", contentWithSummary);
string contentWithDefaultSummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<summary>
Summary description for the ClassName class.
</summary>
</ClassName>
";
resolver.XmlReferences.Add("ClassWithDefaultSummary.xml", contentWithDefaultSummary);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return(project);
}
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentClassInheritDoc = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<inheritdoc/>
</TestClass>
";
resolver.XmlReferences.Add("ClassInheritDoc.xml", contentClassInheritDoc);
string contentMethodInheritDoc = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<TestMethod>
<inheritdoc/>
</TestMethod>
</TestClass>
";
resolver.XmlReferences.Add("MethodInheritDoc.xml", contentMethodInheritDoc);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return(project);
}
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentSummaryWithoutPlaceHolder = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<summary>
This is a test class.
</summary>
</TestClass>
";
resolver.XmlReferences.Add("SummaryWithoutPlaceHolder.xml", contentSummaryWithoutPlaceHolder);
string contentSummaryWithPlaceHolder = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<summary>
<placeholder>This is a test class.</placeholder>
</summary>
</TestClass>
";
resolver.XmlReferences.Add("SummaryWithPlaceHolder.xml", contentSummaryWithPlaceHolder);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return(project);
}
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentTypeWithTypeparamDoc = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<Foo>
<summary>Test class</summary>
<typeparam name=""Ta"">Param 1</typeparam>
<typeparam name=""Tb"">Param 2</typeparam>
</Foo>
";
resolver.XmlReferences.Add("TypeWithTypeparamsDoc.xml", contentTypeWithTypeparamDoc);
string contentTypeWithEmptyTypeparamDoc = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<Foo>
<summary>Test class</summary>
<typeparam name=""Ta""></typeparam>
<typeparam name=""Tb""/>
</Foo>
";
resolver.XmlReferences.Add("TypeWithEmptyTypeparamsDoc.xml", contentTypeWithEmptyTypeparamDoc);
string contentMethodWithTypeparamDoc = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Foo>
<summary>Test class</summary>
<typeparam name=""Ta"">Param 1</typeparam>
<typeparam name=""Tb"">Param 2</typeparam>
</Foo>
</TestClass>
";
resolver.XmlReferences.Add("MethodWithTypeparamsDoc.xml", contentMethodWithTypeparamDoc);
string contentMethodWithEmptyTypeparamDoc = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Foo>
<summary>Test class</summary>
<typeparam name=""Ta""/>
<typeparam name=""Tb""></typeparam>
</Foo>
</TestClass>
";
resolver.XmlReferences.Add("MethodWithEmptyTypeparamsDoc.xml", contentMethodWithEmptyTypeparamDoc);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return(project);
}
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentClassInheritDoc = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<summary>Test class</summary>
</TestClass>
";
resolver.XmlReferences.Add("ClassInheritDoc.xml", contentClassInheritDoc);
string contentInvalidClassInheritDoc = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<summary>Test class<summary>
</TestClass>
";
resolver.XmlReferences.Add("InvalidClassInheritDoc.xml", contentInvalidClassInheritDoc);
string contentPropertyInheritDoc = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<TestProperty>
<summary>Gets or sets test property</summary>
<value>Dummy integer</value>
</TestProperty>
</TestClass>
";
resolver.XmlReferences.Add("PropertyInheritDoc.xml", contentPropertyInheritDoc);
string contentMethodInheritDoc = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<TestMethod>
<summary>Test method</summary>
<typeparam name=""T"">Template type</typeparam>
<param name=""arg1"">First argument</param>
<returns>Some value</returns>
<remarks>Random remark</remarks>
<example>Random example</example>
<exception cref=""System.Exception"">Exception description</exception>
<permission cref=""System.Security.PermissionSet"">Everyone can access this method</permission>
</TestMethod>
</TestClass>
";
resolver.XmlReferences.Add("MethodInheritDoc.xml", contentMethodInheritDoc);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return(project);
}
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentWithValue = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Property>
<summary>Foo</summary>
<value>Bar</value>
</Property>
</ClassName>
";
resolver.XmlReferences.Add("PropertyWithValue.xml", contentWithValue);
string contentWithoutValue = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Property>
<summary>Foo</summary>
</Property>
</ClassName>
";
resolver.XmlReferences.Add("PropertyWithoutValue.xml", contentWithoutValue);
string contentWithEmptyValue = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Property>
<summary>Foo</summary>
<value> </value>
</Property>
</ClassName>
";
resolver.XmlReferences.Add("PropertyWithEmptyValue.xml", contentWithEmptyValue);
string contentWithInheritdocValue = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Property>
<inheritdoc/>
</Property>
</ClassName>
";
resolver.XmlReferences.Add("PropertyWithInheritdoc.xml", contentWithInheritdocValue);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return(project);
}
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentValidSummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Destructor>
<summary>Finalizes an instance of the <see cref=""TestClass""/> class.</summary>
</Destructor>
</TestClass>
";
resolver.XmlReferences.Add("ValidSummary.xml", contentValidSummary);
string contentMissingSummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Destructor>
</Destructor>
</TestClass>
";
resolver.XmlReferences.Add("MissingSummary.xml", contentMissingSummary);
string contentEmptySummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Destructor>
<summary></summary>
</Destructor>
</TestClass>
";
resolver.XmlReferences.Add("EmptySummary.xml", contentEmptySummary);
string contentInvalidSummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Destructor>
<summary>Creates the <see cref=""TestClass""/> class.</summary>
</Destructor>
</TestClass>
";
resolver.XmlReferences.Add("InvalidSummary.xml", contentInvalidSummary);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return(project);
}
/// <inheritdoc/>
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentWithSummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<Class1>
<MethodName>
<summary>
Sample method.
</summary>
<returns>
A <see cref=""Task""/> representing the asynchronous operation.
</returns>
</MethodName>
</Class1>
";
resolver.XmlReferences.Add("ClassWithSummary.xml", contentWithSummary);
string contentWithInheritedSummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<Class1>
<MethodName>
<inheritdoc/>
</MethodName>
</Class1>
";
resolver.XmlReferences.Add("ClassWithInheritedSummary.xml", contentWithInheritedSummary);
string contentWithEmptySummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<Class1>
<MethodName>
<summary>
</summary>
<returns>
A <see cref=""Task""/> representing the asynchronous operation.
</returns>
</MethodName>
</Class1>
";
resolver.XmlReferences.Add("ClassWithEmptySummary.xml", contentWithEmptySummary);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return(project);
}
/// <inheritdoc/>
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentWithoutElementDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<TestMethod>
<summary>
Foo
</summary>
</TestMethod>
</TestClass>
";
resolver.XmlReferences.Add("MissingElementDocumentation.xml", contentWithoutElementDocumentation);
string contentWithElementDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<TestMethod>
<summary>
Foo
</summary>
<param name=""param1"">Param 1</param>
<param name=""param2"">Param 2</param>
<param name=""param3"">Param 3</param>
</TestMethod>
</TestClass>
";
resolver.XmlReferences.Add("WithElementDocumentation.xml", contentWithElementDocumentation);
string contentWithInheritedDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<TestMethod>
<inheritdoc />
</TestMethod>
</TestClass>
";
resolver.XmlReferences.Add("InheritedDocumentation.xml", contentWithInheritedDocumentation);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return(project);
}
/// <inheritdoc/>
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentWithoutSummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
</ClassName>
";
resolver.XmlReferences.Add("ClassWithoutSummary.xml", contentWithoutSummary);
string contentWithInheritdoc = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<inheritdoc/>
</ClassName>
";
resolver.XmlReferences.Add("ClassWithInheritdoc.xml", contentWithInheritdoc);
string contentWithSummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<summary>
Foo
</summary>
</ClassName>
";
resolver.XmlReferences.Add("ClassWithSummary.xml", contentWithSummary);
string contentWithContent = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<content>
Foo
</content>
</ClassName>
";
resolver.XmlReferences.Add("ClassWithContent.xml", contentWithContent);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return(project);
}
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentClassWithTypeparamDoc = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<summary>Test class</summary>
<typeparam name=""T"">Param 1</typeparam>
</TestClass>
";
resolver.XmlReferences.Add("ClassWithTypeparamDoc.xml", contentClassWithTypeparamDoc);
string contentClassWithoutSummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
</TestClass>
";
resolver.XmlReferences.Add("ClassWithoutSummary.xml", contentClassWithoutSummary);
string contentClassWithoutTypeparamDoc = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<summary>Test class</summary>
</TestClass>
";
resolver.XmlReferences.Add("ClassWithoutTypeparamDoc.xml", contentClassWithoutTypeparamDoc);
string contentClassInheritdoc = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<inheritdoc/>
</TestClass>
";
resolver.XmlReferences.Add("ClassWithIneheritdoc.xml", contentClassInheritdoc);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return(project);
}
/// <inheritdoc/>
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentWithoutParamDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("MissingParamDocumentation.xml", contentWithoutParamDocumentation);
string contentWithParamDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<param name=""foo"">Param 1</param>
<param name=""bar"">Param 2</param>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("WithParamDocumentation.xml", contentWithParamDocumentation);
string contentWithInvalidParamDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<param name=""boo"">Param 1</param>
<param name=""far"">Param 2</param>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("WithInvalidParamDocumentation.xml", contentWithInvalidParamDocumentation);
string contentWithSA1613ParamDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<param>Test</param>
<param/>
<param name="""">Test</param>
<param name="" "">Test</param>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("WithSA1613ParamDocumentation.xml", contentWithSA1613ParamDocumentation);
string contentWithTooManyParamDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<param name=""foo"">Param 1</param>
<param name=""bar"">Param 2</param>
<param name=""bar"">Param 3</param>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("WithTooManyParamDocumentation.xml", contentWithTooManyParamDocumentation);
string contentWithInheritedDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<inheritdoc />
</Method>
</ClassName>
";
resolver.XmlReferences.Add("WithInheritedDocumentation.xml", contentWithInheritedDocumentation);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return(project);
}
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentAllFilled = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<TestMethod>
<summary>This is a test method.</summary>
<param name=""first"">The first parameter.</param>
<remarks>Test remarks</remarks>
<example>Test example</example>
<permission>Test permission</permission>
<exception>Test exception</exception>
</TestMethod>
</TestClass>
";
resolver.XmlReferences.Add("AllFilled.xml", contentAllFilled);
string contentInheritDoc = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<TestMethod>
<inheritdoc/>
</TestMethod>
</TestClass>
";
resolver.XmlReferences.Add("InheritDoc.xml", contentInheritDoc);
string contentAllButOneFilled = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<TestMethod>
<summary>This is a test method.</summary>
<param name=""first"">The first parameter.</param>
<remarks>Test remarks</remarks>
<example>Test example</example>
<permission></permission>
<exception>Test exception</exception>
</TestMethod>
</TestClass>
";
resolver.XmlReferences.Add("AllButOneFilled.xml", contentAllButOneFilled);
string contentNoneFilled = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<TestMethod>
<summary>This is a test method.</summary>
<param name=""first"">The first parameter.</param>
<remarks></remarks>
<example></example>
<permission></permission>
<exception></exception>
</TestMethod>
</TestClass>
";
resolver.XmlReferences.Add("NoneFilled.xml", contentNoneFilled);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return(project);
}
/// <inheritdoc/>
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentWithoutDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("NoDocumentation.xml", contentWithoutDocumentation);
string contentWithoutParamDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("NoParamDocumentation.xml", contentWithoutParamDocumentation);
string contentWithParamDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<param name=""foo"">Test</param>
<param name=""bar"">Test</param>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("ParamDocumentation.xml", contentWithParamDocumentation);
string contentWithEmptyParamDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<param name=""foo""></param>
<param name=""bar"">
</param>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("EmptyParamDocumentation.xml", contentWithEmptyParamDocumentation);
string contentWithEmptyParamDocumentation2 = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<param name=""foo""/>
<param name=""bar"">
<para>
</para>
</param>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("EmptyParamDocumentation2.xml", contentWithEmptyParamDocumentation2);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return project;
}
/// <inheritdoc/>
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentWithoutParamDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("MissingParamDocumentation.xml", contentWithoutParamDocumentation);
string contentWithParamDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<param name=""foo"">Param 1</param>
<param name=""bar"">Param 2</param>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("WithParamDocumentation.xml", contentWithParamDocumentation);
string contentWithInvalidParamDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<param>Test</param>
<param/>
<param name="""">Test</param>
<param name="" "">Test</param>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("WithInvalidParamDocumentation.xml", contentWithInvalidParamDocumentation);
string contentWithInheritedDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<inheritdoc />
<param>Test</param>
<param/>
<param name="""">Test</param>
<param name="" "">Test</param>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("WithInheritedDocumentation.xml", contentWithInheritedDocumentation);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return project;
}
/// <inheritdoc/>
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentWithoutDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("NoDocumentation.xml", contentWithoutDocumentation);
string contentWithoutParamDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("NoParamDocumentation.xml", contentWithoutParamDocumentation);
string contentWithParamDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<param name=""foo"">Test</param>
<param name=""bar"">Test</param>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("ParamDocumentation.xml", contentWithParamDocumentation);
string contentWithEmptyParamDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<param name=""foo""></param>
<param name=""bar"">
</param>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("EmptyParamDocumentation.xml", contentWithEmptyParamDocumentation);
string contentWithEmptyParamDocumentation2 = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<param name=""foo""/>
<param name=""bar"">
<para>
</para>
</param>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("EmptyParamDocumentation2.xml", contentWithEmptyParamDocumentation2);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return(project);
}
/// <inheritdoc/>
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentWithoutElementDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<TestMethod>
<summary>
Foo
</summary>
</TestMethod>
</TestClass>
";
resolver.XmlReferences.Add("MissingElementDocumentation.xml", contentWithoutElementDocumentation);
string contentWithElementDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<TestMethod>
<summary>
Foo
</summary>
<param name=""param1"">Param 1</param>
<param name=""param2"">Param 2</param>
<param name=""param3"">Param 3</param>
</TestMethod>
</TestClass>
";
resolver.XmlReferences.Add("WithElementDocumentation.xml", contentWithElementDocumentation);
string contentWithInheritedDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<TestMethod>
<inheritdoc />
</TestMethod>
</TestClass>
";
resolver.XmlReferences.Add("InheritedDocumentation.xml", contentWithInheritedDocumentation);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return project;
}
/// <inheritdoc/>
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentWithoutSummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
</ClassName>
";
resolver.XmlReferences.Add("ClassWithoutSummary.xml", contentWithoutSummary);
string contentWithSummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<summary>
Foo
</summary>
</ClassName>
";
resolver.XmlReferences.Add("ClassWithSummary.xml", contentWithSummary);
string contentWithDefaultSummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<summary>
Summary description for the ClassName class.
</summary>
</ClassName>
";
resolver.XmlReferences.Add("ClassWithDefaultSummary.xml", contentWithDefaultSummary);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return project;
}
/// <inheritdoc/>
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string correctDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Test>
<summary>
Some documentation.
</summary>
<remark>Some remark.</remark>
</Test>
</TestClass>
";
resolver.XmlReferences.Add("Correct.xml", correctDocumentation);
string correctWithEmptyReferenceElements = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Test>
<summary>
Some documentation <see cref=""TestClass""/>.
</summary>
<summary>
Some documentation <see cref=""TestClass2""/>.
</summary>
<remark>Some remark.</remark>
</Test>
</TestClass>
";
resolver.XmlReferences.Add("CorrectWithEmptyElements.xml", correctWithEmptyReferenceElements);
string correctWithEmptyElements = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Test>
<summary></summary>
<remark></remark>
</Test>
</TestClass>
";
resolver.XmlReferences.Add("CorrectEmpty.xml", correctWithEmptyElements);
string inherited = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Test>
<inheritdoc />
</Test>
</TestClass>
";
resolver.XmlReferences.Add("Inherited.xml", inherited);
string badWithNormalization = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Test>
<summary>
Some documentation <see cref=""TestClass""/>.
</summary>
<summary>
Some documentation <see cref = ""TestClass"" />.
</summary>
<remark>Some remark.</remark>
</Test>
</TestClass>
";
resolver.XmlReferences.Add("BadWithNormalization.xml", badWithNormalization);
string badWithDuplicates = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Test>
<summary>Some documentation.</summary>
<remark>Some documentation.</remark>
</Test>
</TestClass>
";
resolver.XmlReferences.Add("BadWithDuplicates.xml", badWithDuplicates);
string badWithDuplicates2 = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Test>
<summary>
Some documentation.
</summary>
<remark> Some documentation. </remark>
</Test>
</TestClass>
";
resolver.XmlReferences.Add("BadWithDuplicates2.xml", badWithDuplicates2);
string withIgnoredParameters = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Test>
<summary>The parameter is not used.</summary>
<remark>The parameter is not used.</remark>
</Test>
</TestClass>
";
resolver.XmlReferences.Add("WithIgnoredParameters.xml", withIgnoredParameters);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return(project);
}
/// <inheritdoc/>
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentWithReturns = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<Class1>
<MethodName>
<summary>
Sample method.
</summary>
<returns>
A <see cref=""Task""/> representing the asynchronous operation.
</returns>
</MethodName>
</Class1>
";
resolver.XmlReferences.Add("MethodWithReturns.xml", contentWithReturns);
string contentWithInheritedReturns = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<Class1>
<MethodName>
<inheritdoc/>
</MethodName>
</Class1>
";
resolver.XmlReferences.Add("MethodWithInheritedReturns.xml", contentWithInheritedReturns);
string contentWithoutReturns = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<Class1>
<MethodName>
<summary>
Sample method.
</summary>
</MethodName>
</Class1>
";
resolver.XmlReferences.Add("MethodWithoutReturns.xml", contentWithoutReturns);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return project;
}
/// <inheritdoc/>
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentWithoutDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("NoDocumentation.xml", contentWithoutDocumentation);
string contentWithoutReturns = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("WithoutReturns.xml", contentWithoutReturns);
string contentWithReturns = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<returns>Test</returns>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("WithReturns.xml", contentWithReturns);
string contentWithEmptyReturns = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<returns>
</returns>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("WithEmptyReturns.xml", contentWithEmptyReturns);
string contentWithEmptyReturns2 = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<returns />
</Method>
</ClassName>
";
resolver.XmlReferences.Add("WithEmptyReturns2.xml", contentWithEmptyReturns2);
string contentWithEmptyReturns3 = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<returns></returns>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("WithEmptyReturns3.xml", contentWithEmptyReturns3);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return(project);
}
/// <inheritdoc/>
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string correctDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Test>
<summary>
Some documentation.
</summary>
<remark>Some remark.</remark>
</Test>
</TestClass>
";
resolver.XmlReferences.Add("Correct.xml", correctDocumentation);
string correctWithEmptyReferenceElements = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Test>
<summary>
Some documentation <see cref=""TestClass""/>.
</summary>
<summary>
Some documentation <see cref=""TestClass2""/>.
</summary>
<remark>Some remark.</remark>
</Test>
</TestClass>
";
resolver.XmlReferences.Add("CorrectWithEmptyElements.xml", correctWithEmptyReferenceElements);
string correctWithEmptyElements = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Test>
<summary></summary>
<remark></remark>
</Test>
</TestClass>
";
resolver.XmlReferences.Add("CorrectEmpty.xml", correctWithEmptyElements);
string inherited = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Test>
<inheritdoc />
</Test>
</TestClass>
";
resolver.XmlReferences.Add("Inherited.xml", inherited);
string badWithNormalization = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Test>
<summary>
Some documentation <see cref=""TestClass""/>.
</summary>
<summary>
Some documentation <see cref = ""TestClass"" />.
</summary>
<remark>Some remark.</remark>
</Test>
</TestClass>
";
resolver.XmlReferences.Add("BadWithNormalization.xml", badWithNormalization);
string badWithDuplicates = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Test>
<summary>Some documentation.</summary>
<remark>Some documentation.</remark>
</Test>
</TestClass>
";
resolver.XmlReferences.Add("BadWithDuplicates.xml", badWithDuplicates);
string badWithDuplicates2 = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Test>
<summary>
Some documentation.
</summary>
<remark> Some documentation. </remark>
</Test>
</TestClass>
";
resolver.XmlReferences.Add("BadWithDuplicates2.xml", badWithDuplicates2);
string withIgnoredParameters = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Test>
<summary>The parameter is not used.</summary>
<remark>The parameter is not used.</remark>
</Test>
</TestClass>
";
resolver.XmlReferences.Add("WithIgnoredParameters.xml", withIgnoredParameters);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return project;
}
/// <inheritdoc/>
protected override Project ApplyCompilationOptions(Project project)
{
var resolver = new TestXmlReferenceResolver();
string contentWithoutDocumentation = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("NoDocumentation.xml", contentWithoutDocumentation);
string contentWithoutReturns = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("WithoutReturns.xml", contentWithoutReturns);
string contentWithReturns = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<returns>Test</returns>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("WithReturns.xml", contentWithReturns);
string contentWithEmptyReturns = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<returns>
</returns>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("WithEmptyReturns.xml", contentWithEmptyReturns);
string contentWithEmptyReturns2 = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<returns />
</Method>
</ClassName>
";
resolver.XmlReferences.Add("WithEmptyReturns2.xml", contentWithEmptyReturns2);
string contentWithEmptyReturns3 = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<ClassName>
<Method>
<summary>
Foo
</summary>
<returns></returns>
</Method>
</ClassName>
";
resolver.XmlReferences.Add("WithEmptyReturns3.xml", contentWithEmptyReturns3);
project = base.ApplyCompilationOptions(project);
project = project.WithCompilationOptions(project.CompilationOptions.WithXmlReferenceResolver(resolver));
return project;
}
