Skip to content

Commit 15db20c

Browse files
Fix warnings.
1 parent a3386e3 commit 15db20c

File tree

4 files changed

+19
-2
lines changed

4 files changed

+19
-2
lines changed

src/Text.Templating.Razor/IRazorTextTemplateRenderer.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,19 @@
66

77
namespace PosInformatique.Foundations.Text.Templating.Razor
88
{
9+
/// <summary>
10+
/// Used internaly by the <see cref="RazorTextTemplate{TModel}"/> to render a Razor component to a text output.
11+
/// </summary>
912
internal interface IRazorTextTemplateRenderer
1013
{
14+
/// <summary>
15+
/// Generates the text output of a Razor component.
16+
/// </summary>
17+
/// <param name="componentType">Type of the Razor component which will be use to generate the text.</param>
18+
/// <param name="model">Model to inject in the Razor component.</param>
19+
/// <param name="output">Output where the text will be generated.</param>
20+
/// <param name="cancellationToken"><see cref="CancellationToken"/> used to cancel the generation process.</param>
21+
/// <returns>An instance of the <see cref="Task"/> which represents the asynchronous operation.</returns>
1122
Task RenderAsync(Type componentType, object? model, TextWriter output, CancellationToken cancellationToken = default);
1223
}
1324
}

stylecop.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{
1+
{
22
"settings": {
33
"documentationRules": {
44
"companyName": "P.O.S Informatique",

tests/.editorconfig

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ dotnet_diagnostic.CA1806.severity = none
1010
# S1144: Unused private types or members should be removed
1111
dotnet_diagnostic.S1144.severity = none
1212

13+
# S2094: Classes should not be empty
14+
dotnet_diagnostic.S2094.severity = none
15+
1316
# S3459: Unassigned members should be removed
1417
dotnet_diagnostic.S3459.severity = none
1518

@@ -24,6 +27,9 @@ dotnet_diagnostic.SA1312.severity = none
2427
# SA1600: Elements should be documented
2528
dotnet_diagnostic.SA1600.severity = none
2629

30+
# SA1601: Partial elements should be documented
31+
dotnet_diagnostic.SA1601.severity = none
32+
2733
#### Visual Studio ####
2834

2935
# IDE0017: Simplify object initialization

tests/Text.Templating.Razor.Tests/ComponentTest.razor.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ public partial class ComponentTest : ComponentBase
1616
[Parameter]
1717
public RazorTextTemplateRendererTest.ModelTest Model { get; set; }
1818
}
19-
}
19+
}

0 commit comments

Comments
 (0)