public void ShouldDocument(string uncommentedCode, string expectedCommentedCode)
{
// Arrange
var options = new CtorDocumentationOptions
{
Enabled = true,
Required = true,
Summary = new SummaryDocumentationOptions
{
Template = "Creates a new instance of the {name} class."
},
Parameters = new ParamsDocumentationOptions
{
Enabled = true,
Template = "The {name}."
},
Exceptions = new ExceptionDocumentationOptions
{
Enabled = true
}
};
var ctorDeclarationSyntax = SyntaxUtils.Parse <ConstructorDeclarationSyntax>(uncommentedCode);
var strategy = new ConstructorDocumentationStrategy(NullLogger <ConstructorDocumentationStrategy> .Instance,
new HumanizeFormatter(new DocumentationOptions()),
options);
// Act
var documentedSyntax = strategy.Apply(ctorDeclarationSyntax);
// Assert
documentedSyntax.ToFullString().Trim().ShouldBe(expectedCommentedCode.Trim());
}
public void Setup()
{
_classDocumentationStrategy = new ClassDocumentationStrategy(
NullLogger <ClassDocumentationStrategy> .Instance,
new HumanizeFormatter(new DocumentationOptions()),
new ClassDocumentationOptions());
_classDeclarationSyntax = SyntaxUtils.Parse <ClassDeclarationSyntax>(ClassWithInheritance);
}
public void ShouldDocument(string uncommentedCode, string expectedCommentedCode)
{
// Arrange
var classDeclarationSyntax = SyntaxUtils.Parse <ClassDeclarationSyntax>(uncommentedCode);
var strategy = new ClassDocumentationStrategy(NullLogger <ClassDocumentationStrategy> .Instance,
new HumanizeFormatter(new DocumentationOptions()),
new ClassDocumentationOptions());
// Act
var documentedSyntax = strategy.Apply(classDeclarationSyntax);
// Assert
documentedSyntax.ToFullString().ShouldBe(expectedCommentedCode);
}
