Add XMLDOC

inyutin-maxim · inyutin-maxim · commit 5a7e399afed9 · 2022-10-09T21:23:17.000+03:00
diff --git a/System.IO.Abstractions.Analyzers/Analyzers/BaseFileSystemNodeAnalyzer.cs b/System.IO.Abstractions.Analyzers/Analyzers/BaseFileSystemNodeAnalyzer.cs
@@ -6,8 +6,10 @@
 
 namespace System.IO.Abstractions.Analyzers.Analyzers;
 
+/// <inheritdoc />
 public abstract class BaseFileSystemNodeAnalyzer : BaseFileSystemAnalyzer
 {
+	/// <inheritdoc />
 	protected override void AnalyzeCompilation(CompilationStartAnalysisContext compilationStartContext,
 												FileSystemContext fileSystemContext)
 	{
diff --git a/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/DirectoryAnalyzer.cs b/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/DirectoryAnalyzer.cs
@@ -6,6 +6,9 @@
 
 namespace System.IO.Abstractions.Analyzers.Analyzers.FileSystemTypeAnalyzers;
 
+/// <summary>
+/// Search method invocation from Directory class in code
+/// </summary>
 [DiagnosticAnalyzer(LanguageNames.CSharp)]
 public class DirectoryAnalyzer : BaseFileSystemNodeAnalyzer
 {
@@ -33,7 +36,7 @@ public class DirectoryAnalyzer : BaseFileSystemNodeAnalyzer
 	private const string Link = "http://bit.ly/2Oz9iSx";
 
 	/// <summary>
-	/// Правило
+	/// Diagnostic rule
 	/// </summary>
 	private static readonly DiagnosticDescriptor Rule = new(DiagnosticId,
 		Title,
diff --git a/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/DirectoryInfoAnalyzer.cs b/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/DirectoryInfoAnalyzer.cs
@@ -6,6 +6,9 @@
 
 namespace System.IO.Abstractions.Analyzers.Analyzers.FileSystemTypeAnalyzers;
 
+/// <summary>
+/// Search method invocation from DirectoryInfo class in code
+/// </summary>
 [DiagnosticAnalyzer(LanguageNames.CSharp)]
 public class DirectoryInfoAnalyzer : BaseFileSystemNodeAnalyzer
 {
@@ -33,7 +36,7 @@ public class DirectoryInfoAnalyzer : BaseFileSystemNodeAnalyzer
 	private const string Link = "http://bit.ly/2OCAmQF";
 
 	/// <summary>
-	/// Правило
+	/// Diagnostic rule
 	/// </summary>
 	private static readonly DiagnosticDescriptor Rule = new(DiagnosticId,
 		Title,
diff --git a/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/FileAnalyzer.cs b/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/FileAnalyzer.cs
@@ -6,6 +6,9 @@
 
 namespace System.IO.Abstractions.Analyzers.Analyzers.FileSystemTypeAnalyzers;
 
+/// <summary>
+/// Search method invocation from File class in code
+/// </summary>
 [DiagnosticAnalyzer(LanguageNames.CSharp)]
 public class FileAnalyzer : BaseFileSystemNodeAnalyzer
 {
@@ -33,7 +36,7 @@ public class FileAnalyzer : BaseFileSystemNodeAnalyzer
 	private const string Link = "http://bit.ly/2ODMgdq";
 
 	/// <summary>
-	/// Правило
+	/// Diagnostic rule
 	/// </summary>
 	private static readonly DiagnosticDescriptor Rule = new(DiagnosticId,
 		Title,
diff --git a/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/FileInfoAnalyzer.cs b/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/FileInfoAnalyzer.cs
@@ -6,6 +6,9 @@
 
 namespace System.IO.Abstractions.Analyzers.Analyzers.FileSystemTypeAnalyzers;
 
+/// <summary>
+/// Search method invocation from FileInfo class in code
+/// </summary>
 [DiagnosticAnalyzer(LanguageNames.CSharp)]
 public class FileInfoAnalyzer : BaseFileSystemNodeAnalyzer
 {
@@ -33,7 +36,7 @@ public class FileInfoAnalyzer : BaseFileSystemNodeAnalyzer
 	private const string Link = "http://bit.ly/2OAA4tM";
 
 	/// <summary>
-	/// Правило
+	/// Diagnostic rule
 	/// </summary>
 	private static readonly DiagnosticDescriptor Rule = new(DiagnosticId,
 		Title,
diff --git a/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/FileStreamAnalyzer.cs b/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/FileStreamAnalyzer.cs
@@ -6,6 +6,9 @@
 
 namespace System.IO.Abstractions.Analyzers.Analyzers.FileSystemTypeAnalyzers;
 
+/// <summary>
+/// Search method invocation from FileStream class in code
+/// </summary>
 [DiagnosticAnalyzer(LanguageNames.CSharp)]
 public class FileStreamAnalyzer : BaseFileSystemNodeAnalyzer
 {
@@ -33,7 +36,7 @@ public class FileStreamAnalyzer : BaseFileSystemNodeAnalyzer
 	private const string Link = "http://bit.ly/2Oz5MaM";
 
 	/// <summary>
-	/// Правило
+	/// Diagnostic rule
 	/// </summary>
 	private static readonly DiagnosticDescriptor Rule = new(DiagnosticId,
 		Title,
diff --git a/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/PathAnalyzer.cs b/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/PathAnalyzer.cs
@@ -6,6 +6,9 @@
 
 namespace System.IO.Abstractions.Analyzers.Analyzers.FileSystemTypeAnalyzers;
 
+/// <summary>
+/// Search method invocation from Path class in code
+/// </summary>
 [DiagnosticAnalyzer(LanguageNames.CSharp)]
 public class PathAnalyzer : BaseFileSystemNodeAnalyzer
 {
@@ -33,7 +36,7 @@ public class PathAnalyzer : BaseFileSystemNodeAnalyzer
 	private const string Link = "http://bit.ly/2ODMkKc";
 
 	/// <summary>
-	/// Правило
+	/// Diagnostic rule
 	/// </summary>
 	private static readonly DiagnosticDescriptor Rule = new(DiagnosticId,
 		Title,
diff --git a/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/StreamReaderAnalyzer.cs b/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/StreamReaderAnalyzer.cs
@@ -6,6 +6,9 @@
 
 namespace System.IO.Abstractions.Analyzers.Analyzers.FileSystemTypeAnalyzers;
 
+/// <summary>
+/// Search StreamReader in Code
+/// </summary>
 [DiagnosticAnalyzer(LanguageNames.CSharp)]
 public class StreamReaderAnalyzer : BaseFileSystemNodeAnalyzer
 {
@@ -32,7 +35,7 @@ public class StreamReaderAnalyzer : BaseFileSystemNodeAnalyzer
 	private const string Description = Title;
 
 	/// <summary>
-	/// Правило
+	/// Diagnostic rule
 	/// </summary>
 	private static readonly DiagnosticDescriptor Rule = new(DiagnosticId,
 		Title,
diff --git a/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/StreamWriterAnalyzer.cs b/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/StreamWriterAnalyzer.cs
@@ -6,6 +6,9 @@
 
 namespace System.IO.Abstractions.Analyzers.Analyzers.FileSystemTypeAnalyzers;
 
+/// <summary>
+/// Search StreamWriter in Code
+/// </summary>
 [DiagnosticAnalyzer(LanguageNames.CSharp)]
 public class StreamWriterAnalyzer : BaseFileSystemNodeAnalyzer
 {
@@ -32,7 +35,7 @@ public class StreamWriterAnalyzer : BaseFileSystemNodeAnalyzer
 	private const string Description = Title;
 
 	/// <summary>
-	/// Правило
+	/// Diagnostic rule
 	/// </summary>
 	private static readonly DiagnosticDescriptor Rule = new(DiagnosticId,
 		Title,
diff --git a/System.IO.Abstractions.Analyzers/CodeActions/DirectoryInfoCodeAction.cs b/System.IO.Abstractions.Analyzers/CodeActions/DirectoryInfoCodeAction.cs
@@ -10,6 +10,9 @@
 
 namespace System.IO.Abstractions.Analyzers.CodeActions;
 
+/// <summary>
+/// Code action to replace a <see cref="DirectoryInfo"/> with a IFileSystem.DirectoryInfo.
+/// </summary>
 public class DirectoryInfoCodeAction : CodeAction
 {
 	private readonly ObjectCreationExpressionSyntax _creationExpressionSyntax;
@@ -27,10 +30,13 @@ public DirectoryInfoCodeAction(string title, Document document, ObjectCreationEx
 		_field = field;
 	}
 
+	/// <inheritdoc />
 	public override string Title { get; }
 
+	/// <inheritdoc />
 	public override string EquivalenceKey => Title;
 
+	/// <inheritdoc />
 	protected override async Task<Document> GetChangedDocumentAsync(CancellationToken cancellationToken)
 	{
 		var editor = await DocumentEditor.CreateAsync(_document, cancellationToken)
diff --git a/System.IO.Abstractions.Analyzers/CodeActions/FileInfoCodeAction.cs b/System.IO.Abstractions.Analyzers/CodeActions/FileInfoCodeAction.cs
@@ -10,6 +10,9 @@
 
 namespace System.IO.Abstractions.Analyzers.CodeActions;
 
+/// <summary>
+/// Code action to replace a <see cref="FileInfo"/> with a IFileSystem.FileInfo.
+/// </summary>
 public class FileInfoCodeAction : CodeAction
 {
 	private readonly ObjectCreationExpressionSyntax _creationExpressionSyntax;
@@ -27,10 +30,13 @@ public FileInfoCodeAction(string title, Document document, ObjectCreationExpress
 		_field = field;
 	}
 
+	/// <inheritdoc />
 	public override string Title { get; }
 
+	/// <inheritdoc />
 	public override string EquivalenceKey => Title;
 
+	/// <inheritdoc />
 	protected override async Task<Document> GetChangedDocumentAsync(CancellationToken cancellationToken)
 	{
 		var editor = await DocumentEditor.CreateAsync(_document, cancellationToken)
diff --git a/System.IO.Abstractions.Analyzers/CodeActions/FileServiceConstructorInitialCodeAction.cs b/System.IO.Abstractions.Analyzers/CodeActions/FileServiceConstructorInitialCodeAction.cs
@@ -12,6 +12,9 @@
 
 namespace System.IO.Abstractions.Analyzers.CodeActions;
 
+/// <summary>
+/// Code action to add IFileSystem as a property to a class.
+/// </summary>
 public class FileServiceConstructorInitialCodeAction : CodeAction
 {
 	private readonly ClassDeclarationSyntax _class;
@@ -25,10 +28,13 @@ public FileServiceConstructorInitialCodeAction(string title, Document document,
 		Title = title;
 	}
 
+	/// <inheritdoc />
 	public override string Title { get; }
 
+	/// <inheritdoc />
 	public override string EquivalenceKey => Title;
 
+	/// <inheritdoc />
 	protected override async Task<Document> GetChangedDocumentAsync(CancellationToken cancellationToken)
 	{
 		var editor = await DocumentEditor.CreateAsync(_document, cancellationToken)
diff --git a/System.IO.Abstractions.Analyzers/CodeActions/FileServiceInterfaceInjectionCodeAction.cs b/System.IO.Abstractions.Analyzers/CodeActions/FileServiceInterfaceInjectionCodeAction.cs
@@ -12,7 +12,9 @@
 
 namespace System.IO.Abstractions.Analyzers.CodeActions;
 
-/// <inheritdoc />
+/// <summary>
+/// Code action to replace FileSystem invocation to IFileSystem service.
+/// </summary>
 public class FileServiceInterfaceInjectionCodeAction : CodeAction
 {
 	private readonly ClassDeclarationSyntax _class;
@@ -26,10 +28,13 @@ public FileServiceInterfaceInjectionCodeAction(string title, Document document,
 		Title = title;
 	}
 
+	/// <inheritdoc />
 	public override string Title { get; }
 
+	/// <inheritdoc />
 	public override string EquivalenceKey => Title;
 
+	/// <inheritdoc />
 	protected override async Task<Document> GetChangedDocumentAsync(CancellationToken cancellationToken)
 	{
 		var editor = await DocumentEditor.CreateAsync(_document, cancellationToken)
diff --git a/System.IO.Abstractions.Analyzers/CodeActions/FileStreamCodeAction.cs b/System.IO.Abstractions.Analyzers/CodeActions/FileStreamCodeAction.cs
@@ -10,6 +10,9 @@
 
 namespace System.IO.Abstractions.Analyzers.CodeActions;
 
+/// <summary>
+/// Code action to replace a <see cref="FileStream"/> with a IFileSystem.File.Create call.
+/// </summary>
 public class FileStreamCodeAction : CodeAction
 {
 	private readonly ObjectCreationExpressionSyntax _creationExpressionSyntax;
@@ -27,10 +30,13 @@ public FileStreamCodeAction(string title, Document document, ObjectCreationExpre
 		_field = field;
 	}
 
+	/// <inheritdoc />
 	public override string Title { get; }
 
+	/// <inheritdoc />
 	public override string EquivalenceKey => Title;
 
+	/// <inheritdoc />
 	protected override async Task<Document> GetChangedDocumentAsync(CancellationToken cancellationToken)
 	{
 		var editor = await DocumentEditor.CreateAsync(_document, cancellationToken)
diff --git a/System.IO.Abstractions.Analyzers/CodeActions/FileSystemInvokeCodeAction.cs b/System.IO.Abstractions.Analyzers/CodeActions/FileSystemInvokeCodeAction.cs
@@ -9,6 +9,9 @@
 
 namespace System.IO.Abstractions.Analyzers.CodeActions;
 
+/// <summary>
+/// Code action to replace with a IFileSystem call.
+/// </summary>
 public class FileSystemInvokeCodeAction : CodeAction
 {
 	private readonly Document _document;
@@ -26,10 +29,13 @@ public FileSystemInvokeCodeAction(string title, Document document, InvocationExp
 		_field = field;
 	}
 
+	/// <inheritdoc />
 	public override string Title { get; }
 
+	/// <inheritdoc />
 	public override string EquivalenceKey => Title;
 
+	/// <inheritdoc />
 	protected override async Task<Document> GetChangedDocumentAsync(CancellationToken cancellationToken)
 	{
 		var editor = await DocumentEditor.CreateAsync(_document, cancellationToken)
diff --git a/System.IO.Abstractions.Analyzers/CodeFixes/BaseInvokeCodeFix.cs b/System.IO.Abstractions.Analyzers/CodeFixes/BaseInvokeCodeFix.cs
@@ -8,16 +8,28 @@
 
 namespace System.IO.Abstractions.Analyzers.CodeFixes;
 
+/// <summary>
+/// Base class for code fixes that replace a <see cref="MemberAccessExpressionSyntax"/> with a <see cref="InvocationExpressionSyntax"/>.
+/// </summary>
 public abstract class BaseInvokeCodeFix : CodeFixProvider
 {
+	/// <summary>
+	/// Diagnostic ID of the analyzer that this code fix provider can fix.
+	/// </summary>
 	protected abstract string DiagnosticId { get; }
 
+	/// <summary>
+	/// Title of the code fix.
+	/// </summary>
 	protected abstract string Title { get; }
 
+	/// <inheritdoc />
 	public override ImmutableArray<string> FixableDiagnosticIds => ImmutableArray.Create(DiagnosticId);
 
+	/// <inheritdoc />
 	public override sealed FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer;
 
+	/// <inheritdoc />
 	public override async sealed Task RegisterCodeFixesAsync(CodeFixContext context)
 	{
 		var root = await context.Document.GetSyntaxRootAsync(context.CancellationToken)
diff --git a/System.IO.Abstractions.Analyzers/CodeFixes/DirectoryCodeFix.cs b/System.IO.Abstractions.Analyzers/CodeFixes/DirectoryCodeFix.cs
@@ -1,9 +1,13 @@
 using System.Composition;
+using System.IO.Abstractions.Analyzers.Analyzers.FileSystemTypeAnalyzers;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CodeFixes;
 
 namespace System.IO.Abstractions.Analyzers.CodeFixes;
 
+/// <summary>
+/// Code fix provider for <see cref="DirectoryAnalyzer"/>.
+/// </summary>
 [Shared]
 [ExportCodeFixProvider(LanguageNames.CSharp, Name = nameof(DirectoryCodeFix))]
 public class DirectoryCodeFix : BaseInvokeCodeFix
@@ -14,7 +18,9 @@ public DirectoryCodeFix()
 	{
 	}
 
+	/// <inheritdoc />
 	protected override string DiagnosticId => Constants.Io0003;
 
+	/// <inheritdoc />
 	protected override string Title => "Use IFileSystem.Directory for improved testability";
 }
diff --git a/System.IO.Abstractions.Analyzers/CodeFixes/DirectoryInfoCodeFix.cs b/System.IO.Abstractions.Analyzers/CodeFixes/DirectoryInfoCodeFix.cs
@@ -1,5 +1,6 @@
 using System.Collections.Immutable;
 using System.Composition;
+using System.IO.Abstractions.Analyzers.Analyzers.FileSystemTypeAnalyzers;
 using System.IO.Abstractions.Analyzers.CodeActions;
 using System.IO.Abstractions.Analyzers.RoslynToken;
 using System.Linq;
@@ -10,6 +11,9 @@
 
 namespace System.IO.Abstractions.Analyzers.CodeFixes;
 
+/// <summary>
+/// Code fix provider for <see cref="DirectoryInfoAnalyzer"/>.
+/// </summary>
 [Shared]
 [ExportCodeFixProvider(LanguageNames.CSharp, Name = nameof(DirectoryInfoCodeFix))]
 public class DirectoryInfoCodeFix : CodeFixProvider
@@ -22,10 +26,13 @@ public DirectoryInfoCodeFix()
 	{
 	}
 
+	/// <inheritdoc />
 	public override ImmutableArray<string> FixableDiagnosticIds => ImmutableArray.Create(Constants.Io0007);
 
+	/// <inheritdoc />
 	public override sealed FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer;
 
+	/// <inheritdoc />
 	public override async Task RegisterCodeFixesAsync(CodeFixContext context)
 	{
 		var root = await context.Document.GetSyntaxRootAsync(context.CancellationToken)
diff --git a/System.IO.Abstractions.Analyzers/CodeFixes/FileCodeFix.cs b/System.IO.Abstractions.Analyzers/CodeFixes/FileCodeFix.cs
diff --git a/System.IO.Abstractions.Analyzers/CodeFixes/FileInfoCodeFix.cs b/System.IO.Abstractions.Analyzers/CodeFixes/FileInfoCodeFix.cs
diff --git a/System.IO.Abstractions.Analyzers/CodeFixes/FileServiceConstructorInitialCodeFix.cs b/System.IO.Abstractions.Analyzers/CodeFixes/FileServiceConstructorInitialCodeFix.cs
diff --git a/System.IO.Abstractions.Analyzers/CodeFixes/FileServiceInterfaceInjectionCodeFix.cs b/System.IO.Abstractions.Analyzers/CodeFixes/FileServiceInterfaceInjectionCodeFix.cs
diff --git a/System.IO.Abstractions.Analyzers/CodeFixes/FileStreamCodeFix.cs b/System.IO.Abstractions.Analyzers/CodeFixes/FileStreamCodeFix.cs
diff --git a/System.IO.Abstractions.Analyzers/CodeFixes/PathCodeFix.cs b/System.IO.Abstractions.Analyzers/CodeFixes/PathCodeFix.cs
diff --git a/System.IO.Abstractions.Analyzers/FileSystemContext.cs b/System.IO.Abstractions.Analyzers/FileSystemContext.cs

Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,10 @@`
`6`	`6`
`7`	`7`	`namespace System.IO.Abstractions.Analyzers.Analyzers;`
`8`	`8`
	`9`	`+/// <inheritdoc />`
`9`	`10`	`public abstract class BaseFileSystemNodeAnalyzer : BaseFileSystemAnalyzer`
`10`	`11`	`{`
	`12`	`+ /// <inheritdoc />`
`11`	`13`	`protected override void AnalyzeCompilation(CompilationStartAnalysisContext compilationStartContext,`
`12`	`14`	`FileSystemContext fileSystemContext)`
`13`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,9 @@`
`10`	`10`
`11`	`11`	`namespace System.IO.Abstractions.Analyzers.CodeActions;`
`12`	`12`
	`13`	`+/// <summary>`
	`14`	`+/// Code action to replace a <see cref="DirectoryInfo"/> with a IFileSystem.DirectoryInfo.`
	`15`	`+/// </summary>`
`13`	`16`	`public class DirectoryInfoCodeAction : CodeAction`
`14`	`17`	`{`
`15`	`18`	`private readonly ObjectCreationExpressionSyntax _creationExpressionSyntax;`
`@@ -27,10 +30,13 @@ public DirectoryInfoCodeAction(string title, Document document, ObjectCreationEx`
`27`	`30`	`_field = field;`
`28`	`31`	`}`
`29`	`32`
	`33`	`+ /// <inheritdoc />`
`30`	`34`	`public override string Title { get; }`
`31`	`35`
	`36`	`+ /// <inheritdoc />`
`32`	`37`	`public override string EquivalenceKey => Title;`
`33`	`38`
	`39`	`+ /// <inheritdoc />`
`34`	`40`	`protected override async Task<Document> GetChangedDocumentAsync(CancellationToken cancellationToken)`
`35`	`41`	`{`
`36`	`42`	`var editor = await DocumentEditor.CreateAsync(_document, cancellationToken)`