From e06e186cafe6e6d669e1aec2ded72ff5d1aa6a9d Mon Sep 17 00:00:00 2001 From: Josef Pihrt Date: Sun, 16 Jan 2022 11:41:59 +0100 Subject: [PATCH] Update documentation for public API --- docs/api.txt | 42 +++++++++++--- .../CodeAnalysis/ITypeSymbol/README.md | 2 +- docs/api/README.md | 6 +- .../AutoInitAccessorDeclaration/README.md | 20 +++++++ .../Roslynator/CSharp/CSharpFactory/README.md | 3 + .../README.md | 45 +++++++++++++++ docs/api/Roslynator/CSharp/README.md | 4 +- .../CSharp/SyntaxInverter/README.md | 10 +++- .../SyntaxLogicalInverter/-ctor/README.md | 15 +++++ .../SyntaxLogicalInverter/Default/README.md | 16 ++++++ .../LogicallyInvert/README.md | 55 +++++++++++++++++++ .../SyntaxLogicalInverter/Options/README.md | 16 ++++++ .../CSharp/SyntaxLogicalInverter/README.md | 44 +++++++++++++++ .../-ctor/README.md | 15 +++++ .../Default/README.md | 16 ++++++ .../SyntaxLogicalInverterOptions/README.md | 39 +++++++++++++ .../UseNotPattern/README.md | 16 ++++++ .../EqualsOrInheritsFrom/README.md | 4 +- .../api/Roslynator/SymbolExtensions/README.md | 2 +- .../CSharp/CSharpTestOptions/-ctor/README.md | 8 ++- .../CommonWithConfigOptions/README.md | 20 +++++++ .../CSharp/CSharpTestOptions/README.md | 5 +- .../WithConfigOptions/README.md | 20 +++++++ .../CommonWithConfigOptions/README.md | 20 +++++++ .../TestOptions/ConfigOptions/README.md | 19 +++++++ .../Roslynator/Testing/TestOptions/README.md | 3 + .../TestOptions/WithConfigOptions/README.md | 20 +++++++ src/CSharp.Workspaces/README.md | 12 +++- 28 files changed, 475 insertions(+), 22 deletions(-) create mode 100644 docs/api/Roslynator/CSharp/CSharpFactory/AutoInitAccessorDeclaration/README.md create mode 100644 docs/api/Roslynator/CSharp/CSharpFactory/SuppressNullableWarningExpression/README.md create mode 100644 docs/api/Roslynator/CSharp/SyntaxLogicalInverter/-ctor/README.md create mode 100644 docs/api/Roslynator/CSharp/SyntaxLogicalInverter/Default/README.md create mode 100644 docs/api/Roslynator/CSharp/SyntaxLogicalInverter/LogicallyInvert/README.md create mode 100644 docs/api/Roslynator/CSharp/SyntaxLogicalInverter/Options/README.md create mode 100644 docs/api/Roslynator/CSharp/SyntaxLogicalInverter/README.md create mode 100644 docs/api/Roslynator/CSharp/SyntaxLogicalInverterOptions/-ctor/README.md create mode 100644 docs/api/Roslynator/CSharp/SyntaxLogicalInverterOptions/Default/README.md create mode 100644 docs/api/Roslynator/CSharp/SyntaxLogicalInverterOptions/README.md create mode 100644 docs/api/Roslynator/CSharp/SyntaxLogicalInverterOptions/UseNotPattern/README.md create mode 100644 docs/api/Roslynator/Testing/CSharp/CSharpTestOptions/CommonWithConfigOptions/README.md create mode 100644 docs/api/Roslynator/Testing/CSharp/CSharpTestOptions/WithConfigOptions/README.md create mode 100644 docs/api/Roslynator/Testing/TestOptions/CommonWithConfigOptions/README.md create mode 100644 docs/api/Roslynator/Testing/TestOptions/ConfigOptions/README.md create mode 100644 docs/api/Roslynator/Testing/TestOptions/WithConfigOptions/README.md diff --git a/docs/api.txt b/docs/api.txt index ba239a85f7..c09bc1b4f9 100644 --- a/docs/api.txt +++ b/docs/api.txt @@ -1,10 +1,10 @@ -assembly Roslynator.Core, Version=2.1.0.0, Culture=neutral, PublicKeyToken=926ea54d246a765e -assembly Roslynator.CSharp, Version=2.1.0.0, Culture=neutral, PublicKeyToken=926ea54d246a765e -assembly Roslynator.CSharp.Workspaces, Version=2.1.0.0, Culture=neutral, PublicKeyToken=926ea54d246a765e -assembly Roslynator.Testing.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=926ea54d246a765e -assembly Roslynator.Testing.CSharp, Version=1.0.0.0, Culture=neutral, PublicKeyToken=926ea54d246a765e -assembly Roslynator.Testing.CSharp.Xunit, Version=1.0.0.0, Culture=neutral, PublicKeyToken=926ea54d246a765e -assembly Roslynator.Workspaces.Core, Version=2.1.0.0, Culture=neutral, PublicKeyToken=926ea54d246a765e +assembly Roslynator.Core, Version=2.2.0.1, Culture=neutral, PublicKeyToken=926ea54d246a765e +assembly Roslynator.CSharp, Version=2.2.0.1, Culture=neutral, PublicKeyToken=926ea54d246a765e +assembly Roslynator.CSharp.Workspaces, Version=2.2.0.1, Culture=neutral, PublicKeyToken=926ea54d246a765e +assembly Roslynator.Testing.Common, Version=1.0.0.1, Culture=neutral, PublicKeyToken=926ea54d246a765e +assembly Roslynator.Testing.CSharp, Version=1.0.0.1, Culture=neutral, PublicKeyToken=926ea54d246a765e +assembly Roslynator.Testing.CSharp.Xunit, Version=1.0.0.1, Culture=neutral, PublicKeyToken=926ea54d246a765e +assembly Roslynator.Workspaces.Core, Version=2.2.0.1, Culture=neutral, PublicKeyToken=926ea54d246a765e namespace Roslynator @@ -397,6 +397,7 @@ namespace Roslynator.CSharp public static AttributeListSyntax AttributeList(AttributeSyntax attribute); public static AttributeListSyntax AttributeList(params AttributeSyntax[] attributes); public static AccessorDeclarationSyntax AutoGetAccessorDeclaration(SyntaxTokenList modifiers = default); + public static AccessorDeclarationSyntax AutoInitAccessorDeclaration(SyntaxTokenList modifiers = default); public static AccessorDeclarationSyntax AutoSetAccessorDeclaration(SyntaxTokenList modifiers = default); public static ConstructorInitializerSyntax BaseConstructorInitializer(ArgumentListSyntax argumentList = null); public static ConstructorInitializerSyntax BaseConstructorInitializer(SyntaxToken semicolonToken, ArgumentListSyntax argumentList); @@ -603,6 +604,8 @@ namespace Roslynator.CSharp public static AssignmentExpressionSyntax SubtractAssignmentExpression(ExpressionSyntax left, SyntaxToken operatorToken, ExpressionSyntax right); public static BinaryExpressionSyntax SubtractExpression(ExpressionSyntax left, ExpressionSyntax right); public static BinaryExpressionSyntax SubtractExpression(ExpressionSyntax left, SyntaxToken operatorToken, ExpressionSyntax right); + public static PostfixUnaryExpressionSyntax SuppressNullableWarningExpression(ExpressionSyntax operand); + public static PostfixUnaryExpressionSyntax SuppressNullableWarningExpression(ExpressionSyntax operand, SyntaxToken operatorToken); public static SwitchSectionSyntax SwitchSection(SwitchLabelSyntax switchLabel, StatementSyntax statement); public static SwitchSectionSyntax SwitchSection(SwitchLabelSyntax switchLabel, SyntaxList statements); public static SwitchSectionSyntax SwitchSection(SyntaxList switchLabels, StatementSyntax statement); @@ -1027,11 +1030,29 @@ namespace Roslynator.CSharp public static UsingDirectiveListInfo UsingDirectiveListInfo(SyntaxNode node); public static XmlElementInfo XmlElementInfo(XmlNodeSyntax xmlNode); + [Obsolete("SyntaxInverter is obsolete, use SyntaxLogicalInverter instead.")] public static class SyntaxInverter public static ExpressionSyntax LogicallyInvert(ExpressionSyntax expression, CancellationToken cancellationToken = default); public static ExpressionSyntax LogicallyInvert(ExpressionSyntax expression, SemanticModel semanticModel, CancellationToken cancellationToken = default); + public class SyntaxLogicalInverter + + public SyntaxLogicalInverter(SyntaxLogicalInverterOptions options); + + public static SyntaxLogicalInverter Default { get; } + public SyntaxLogicalInverterOptions Options { get; } + + public ExpressionSyntax LogicallyInvert(ExpressionSyntax expression, CancellationToken cancellationToken = default); + public ExpressionSyntax LogicallyInvert(ExpressionSyntax expression, SemanticModel semanticModel, CancellationToken cancellationToken = default); + + public class SyntaxLogicalInverterOptions + + public SyntaxLogicalInverterOptions(bool useNotPattern = true); + + public static SyntaxLogicalInverterOptions Default { get; } + public bool UseNotPattern { get; } + public static class WorkspaceExtensions public static Task RemoveCommentsAsync(this Document document, CommentFilter comments, CancellationToken cancellationToken = default); @@ -1675,15 +1696,18 @@ namespace Roslynator.Testing protected abstract CompilationOptions CommonCompilationOptions { get; } protected abstract ParseOptions CommonParseOptions { get; } public CompilationOptions CompilationOptions { get; } + public ImmutableDictionary ConfigOptions { get; protected set; } public abstract string Language { get; } public ImmutableArray MetadataReferences { get; protected set; } public ParseOptions ParseOptions { get; } protected abstract TestOptions CommonWithAllowedCompilerDiagnosticIds(IEnumerable values); protected abstract TestOptions CommonWithAllowedCompilerDiagnosticSeverity(DiagnosticSeverity value); + protected abstract TestOptions CommonWithConfigOptions(IEnumerable> values); protected abstract TestOptions CommonWithMetadataReferences(IEnumerable values); public TestOptions WithAllowedCompilerDiagnosticIds(IEnumerable values); public TestOptions WithAllowedCompilerDiagnosticSeverity(DiagnosticSeverity value); + public TestOptions WithConfigOptions(IEnumerable> values); public TestOptions WithMetadataReferences(IEnumerable values); public readonly struct AdditionalFile @@ -1722,7 +1746,7 @@ namespace Roslynator.Testing.CSharp public sealed class CSharpTestOptions : TestOptions - public CSharpTestOptions(CSharpCompilationOptions compilationOptions = null, CSharpParseOptions parseOptions = null, IEnumerable metadataReferences = null, IEnumerable allowedCompilerDiagnosticIds = null, DiagnosticSeverity allowedCompilerDiagnosticSeverity = Info); + public CSharpTestOptions(CSharpCompilationOptions compilationOptions = null, CSharpParseOptions parseOptions = null, IEnumerable metadataReferences = null, IEnumerable allowedCompilerDiagnosticIds = null, DiagnosticSeverity allowedCompilerDiagnosticSeverity = Info, IEnumerable> configOptions = null); protected override CompilationOptions CommonCompilationOptions { get; } protected override ParseOptions CommonParseOptions { get; } @@ -1735,10 +1759,12 @@ namespace Roslynator.Testing.CSharp public CSharpTestOptions AddAllowedCompilerDiagnosticIds(IEnumerable diagnosticIds); protected override TestOptions CommonWithAllowedCompilerDiagnosticIds(IEnumerable values); protected override TestOptions CommonWithAllowedCompilerDiagnosticSeverity(DiagnosticSeverity value); + protected override TestOptions CommonWithConfigOptions(IEnumerable> values); protected override TestOptions CommonWithMetadataReferences(IEnumerable values); public CSharpTestOptions WithAllowedCompilerDiagnosticIds(IEnumerable values); public CSharpTestOptions WithAllowedCompilerDiagnosticSeverity(DiagnosticSeverity value); public CSharpTestOptions WithCompilationOptions(CSharpCompilationOptions compilationOptions); + public CSharpTestOptions WithConfigOptions(IEnumerable> values); public CSharpTestOptions WithMetadataReferences(IEnumerable values); public CSharpTestOptions WithParseOptions(CSharpParseOptions parseOptions); diff --git a/docs/api/Microsoft/CodeAnalysis/ITypeSymbol/README.md b/docs/api/Microsoft/CodeAnalysis/ITypeSymbol/README.md index 35f5bc0f3e..c2c9563d35 100644 --- a/docs/api/Microsoft/CodeAnalysis/ITypeSymbol/README.md +++ b/docs/api/Microsoft/CodeAnalysis/ITypeSymbol/README.md @@ -7,7 +7,7 @@ | [BaseTypes(ITypeSymbol)](../../../Roslynator/SymbolExtensions/BaseTypes/README.md) | Gets a list of base types of this type\. | | [BaseTypesAndSelf(ITypeSymbol)](../../../Roslynator/SymbolExtensions/BaseTypesAndSelf/README.md) | Gets a list of base types of this type \(including this type\)\. | | [EqualsOrInheritsFrom(ITypeSymbol, ITypeSymbol, Boolean)](../../../Roslynator/SymbolExtensions/EqualsOrInheritsFrom/README.md#Roslynator_SymbolExtensions_EqualsOrInheritsFrom_Microsoft_CodeAnalysis_ITypeSymbol_Microsoft_CodeAnalysis_ITypeSymbol_System_Boolean_) | Returns true if the type is equal or inherits from a specified base type\. | -| [EqualsOrInheritsFrom(ITypeSymbol, MetadataName, Boolean)](../../../Roslynator/SymbolExtensions/EqualsOrInheritsFrom/README.md#Roslynator_SymbolExtensions_EqualsOrInheritsFrom_Microsoft_CodeAnalysis_ITypeSymbol_Roslynator_MetadataName__System_Boolean_) | Returns true if the type is equal or inherits from a type wit the specified name\. | +| [EqualsOrInheritsFrom(ITypeSymbol, MetadataName, Boolean)](../../../Roslynator/SymbolExtensions/EqualsOrInheritsFrom/README.md#Roslynator_SymbolExtensions_EqualsOrInheritsFrom_Microsoft_CodeAnalysis_ITypeSymbol_Roslynator_MetadataName__System_Boolean_) | Returns true if the type is equal or inherits from a type with the specified name\. | | [FindMember\(ITypeSymbol, Func\)](../../../Roslynator/SymbolExtensions/FindMember-1/README.md#Roslynator_SymbolExtensions_FindMember__1_Microsoft_CodeAnalysis_ITypeSymbol_System_Func___0_System_Boolean__) | Searches for a member that matches the conditions defined by the specified predicate, if any, and returns the first occurrence within the type's members\. | | [FindMember\(ITypeSymbol, String, Func\)](../../../Roslynator/SymbolExtensions/FindMember-1/README.md#Roslynator_SymbolExtensions_FindMember__1_Microsoft_CodeAnalysis_ITypeSymbol_System_String_System_Func___0_System_Boolean__) | Searches for a member that has the specified name and matches the conditions defined by the specified predicate, if any, and returns the first occurrence within the type's members\. | | [GetDefaultValueSyntax(ITypeSymbol, DefaultSyntaxOptions, SymbolDisplayFormat)](../../../Roslynator/CSharp/WorkspaceSymbolExtensions/GetDefaultValueSyntax/README.md#Roslynator_CSharp_WorkspaceSymbolExtensions_GetDefaultValueSyntax_Microsoft_CodeAnalysis_ITypeSymbol_Roslynator_CSharp_DefaultSyntaxOptions_Microsoft_CodeAnalysis_SymbolDisplayFormat_) | Creates a new [ExpressionSyntax](https://docs.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.csharp.syntax.expressionsyntax) that represents default value of the specified type symbol\. | diff --git a/docs/api/README.md b/docs/api/README.md index 20506b45f6..6c290cd344 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -37,6 +37,8 @@ *   [•](#class-hierarchy-System_Object "Object")   [SyntaxListSelection\](Roslynator/SyntaxListSelection-1/README.md) *   [•](#class-hierarchy-System_Object "Object")   [•](#class-hierarchy-Roslynator_SyntaxListSelection_1 "SyntaxListSelection")   [MemberDeclarationListSelection](Roslynator/CSharp/MemberDeclarationListSelection/README.md) *   [•](#class-hierarchy-System_Object "Object")   [•](#class-hierarchy-Roslynator_SyntaxListSelection_1 "SyntaxListSelection")   [StatementListSelection](Roslynator/CSharp/StatementListSelection/README.md) +*   [•](#class-hierarchy-System_Object "Object")   [SyntaxLogicalInverter](Roslynator/CSharp/SyntaxLogicalInverter/README.md) +*   [•](#class-hierarchy-System_Object "Object")   [SyntaxLogicalInverterOptions](Roslynator/CSharp/SyntaxLogicalInverterOptions/README.md) *   [•](#class-hierarchy-System_Object "Object")   [SyntaxNodeTextBuilder](Roslynator/Text/SyntaxNodeTextBuilder/README.md) *   [•](#class-hierarchy-System_Object "Object")   [TestOptions](Roslynator/Testing/TestOptions/README.md) *   [•](#class-hierarchy-System_Object "Object")   [•](#class-hierarchy-Roslynator_Testing_TestOptions "TestOptions")   [CSharpTestOptions](Roslynator/Testing/CSharp/CSharpTestOptions/README.md) @@ -90,7 +92,9 @@ * [SyntaxAccessibility](Roslynator/CSharp/SyntaxAccessibility/README.md) * [SyntaxExtensions](Roslynator/CSharp/SyntaxExtensions/README.md) * [SyntaxInfo](Roslynator/CSharp/SyntaxInfo/README.md) -* [SyntaxInverter](Roslynator/CSharp/SyntaxInverter/README.md) +* \[deprecated\] [SyntaxInverter](Roslynator/CSharp/SyntaxInverter/README.md) +* [SyntaxLogicalInverter](Roslynator/CSharp/SyntaxLogicalInverter/README.md) +* [SyntaxLogicalInverterOptions](Roslynator/CSharp/SyntaxLogicalInverterOptions/README.md) * [WorkspaceExtensions](Roslynator/CSharp/WorkspaceExtensions/README.md) * [WorkspaceSymbolExtensions](Roslynator/CSharp/WorkspaceSymbolExtensions/README.md) * [WorkspaceSyntaxExtensions](Roslynator/CSharp/WorkspaceSyntaxExtensions/README.md) diff --git a/docs/api/Roslynator/CSharp/CSharpFactory/AutoInitAccessorDeclaration/README.md b/docs/api/Roslynator/CSharp/CSharpFactory/AutoInitAccessorDeclaration/README.md new file mode 100644 index 0000000000..b8ca0c18be --- /dev/null +++ b/docs/api/Roslynator/CSharp/CSharpFactory/AutoInitAccessorDeclaration/README.md @@ -0,0 +1,20 @@ +# CSharpFactory\.AutoInitAccessorDeclaration\(SyntaxTokenList\) Method + +[Home](../../../../README.md) + +**Containing Type**: [CSharpFactory](../README.md) + +**Assembly**: Roslynator\.CSharp\.dll + +```csharp +public static Microsoft.CodeAnalysis.CSharp.Syntax.AccessorDeclarationSyntax AutoInitAccessorDeclaration(Microsoft.CodeAnalysis.SyntaxTokenList modifiers = default) +``` + +### Parameters + +**modifiers**   [SyntaxTokenList](https://docs.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.syntaxtokenlist) + +### Returns + +[AccessorDeclarationSyntax](https://docs.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.csharp.syntax.accessordeclarationsyntax) + diff --git a/docs/api/Roslynator/CSharp/CSharpFactory/README.md b/docs/api/Roslynator/CSharp/CSharpFactory/README.md index d4320cd23e..810b1da720 100644 --- a/docs/api/Roslynator/CSharp/CSharpFactory/README.md +++ b/docs/api/Roslynator/CSharp/CSharpFactory/README.md @@ -46,6 +46,7 @@ public static class CSharpFactory | [AttributeList(AttributeSyntax)](AttributeList/README.md#Roslynator_CSharp_CSharpFactory_AttributeList_Microsoft_CodeAnalysis_CSharp_Syntax_AttributeSyntax_) | | | [AttributeList(AttributeSyntax\[\])](AttributeList/README.md#Roslynator_CSharp_CSharpFactory_AttributeList_Microsoft_CodeAnalysis_CSharp_Syntax_AttributeSyntax___) | | | [AutoGetAccessorDeclaration(SyntaxTokenList)](AutoGetAccessorDeclaration/README.md) | | +| [AutoInitAccessorDeclaration(SyntaxTokenList)](AutoInitAccessorDeclaration/README.md) | | | [AutoSetAccessorDeclaration(SyntaxTokenList)](AutoSetAccessorDeclaration/README.md) | | | [BaseConstructorInitializer(ArgumentListSyntax)](BaseConstructorInitializer/README.md#Roslynator_CSharp_CSharpFactory_BaseConstructorInitializer_Microsoft_CodeAnalysis_CSharp_Syntax_ArgumentListSyntax_) | | | [BaseConstructorInitializer(SyntaxToken, ArgumentListSyntax)](BaseConstructorInitializer/README.md#Roslynator_CSharp_CSharpFactory_BaseConstructorInitializer_Microsoft_CodeAnalysis_SyntaxToken_Microsoft_CodeAnalysis_CSharp_Syntax_ArgumentListSyntax_) | | @@ -252,6 +253,8 @@ public static class CSharpFactory | [SubtractAssignmentExpression(ExpressionSyntax, SyntaxToken, ExpressionSyntax)](SubtractAssignmentExpression/README.md#Roslynator_CSharp_CSharpFactory_SubtractAssignmentExpression_Microsoft_CodeAnalysis_CSharp_Syntax_ExpressionSyntax_Microsoft_CodeAnalysis_SyntaxToken_Microsoft_CodeAnalysis_CSharp_Syntax_ExpressionSyntax_) | | | [SubtractExpression(ExpressionSyntax, ExpressionSyntax)](SubtractExpression/README.md#Roslynator_CSharp_CSharpFactory_SubtractExpression_Microsoft_CodeAnalysis_CSharp_Syntax_ExpressionSyntax_Microsoft_CodeAnalysis_CSharp_Syntax_ExpressionSyntax_) | | | [SubtractExpression(ExpressionSyntax, SyntaxToken, ExpressionSyntax)](SubtractExpression/README.md#Roslynator_CSharp_CSharpFactory_SubtractExpression_Microsoft_CodeAnalysis_CSharp_Syntax_ExpressionSyntax_Microsoft_CodeAnalysis_SyntaxToken_Microsoft_CodeAnalysis_CSharp_Syntax_ExpressionSyntax_) | | +| [SuppressNullableWarningExpression(ExpressionSyntax)](SuppressNullableWarningExpression/README.md#Roslynator_CSharp_CSharpFactory_SuppressNullableWarningExpression_Microsoft_CodeAnalysis_CSharp_Syntax_ExpressionSyntax_) | | +| [SuppressNullableWarningExpression(ExpressionSyntax, SyntaxToken)](SuppressNullableWarningExpression/README.md#Roslynator_CSharp_CSharpFactory_SuppressNullableWarningExpression_Microsoft_CodeAnalysis_CSharp_Syntax_ExpressionSyntax_Microsoft_CodeAnalysis_SyntaxToken_) | | | [SwitchSection(SwitchLabelSyntax, StatementSyntax)](SwitchSection/README.md#Roslynator_CSharp_CSharpFactory_SwitchSection_Microsoft_CodeAnalysis_CSharp_Syntax_SwitchLabelSyntax_Microsoft_CodeAnalysis_CSharp_Syntax_StatementSyntax_) | | | [SwitchSection(SwitchLabelSyntax, SyntaxList\)](SwitchSection/README.md#Roslynator_CSharp_CSharpFactory_SwitchSection_Microsoft_CodeAnalysis_CSharp_Syntax_SwitchLabelSyntax_Microsoft_CodeAnalysis_SyntaxList_Microsoft_CodeAnalysis_CSharp_Syntax_StatementSyntax__) | | | [SwitchSection(SyntaxList\, StatementSyntax)](SwitchSection/README.md#Roslynator_CSharp_CSharpFactory_SwitchSection_Microsoft_CodeAnalysis_SyntaxList_Microsoft_CodeAnalysis_CSharp_Syntax_SwitchLabelSyntax__Microsoft_CodeAnalysis_CSharp_Syntax_StatementSyntax_) | | diff --git a/docs/api/Roslynator/CSharp/CSharpFactory/SuppressNullableWarningExpression/README.md b/docs/api/Roslynator/CSharp/CSharpFactory/SuppressNullableWarningExpression/README.md new file mode 100644 index 0000000000..15cf642f46 --- /dev/null +++ b/docs/api/Roslynator/CSharp/CSharpFactory/SuppressNullableWarningExpression/README.md @@ -0,0 +1,45 @@ +# CSharpFactory\.SuppressNullableWarningExpression Method + +[Home](../../../../README.md) + +**Containing Type**: [CSharpFactory](../README.md) + +**Assembly**: Roslynator\.CSharp\.dll + +## Overloads + +| Method | Summary | +| ------ | ------- | +| [SuppressNullableWarningExpression(ExpressionSyntax)](#Roslynator_CSharp_CSharpFactory_SuppressNullableWarningExpression_Microsoft_CodeAnalysis_CSharp_Syntax_ExpressionSyntax_) | | +| [SuppressNullableWarningExpression(ExpressionSyntax, SyntaxToken)](#Roslynator_CSharp_CSharpFactory_SuppressNullableWarningExpression_Microsoft_CodeAnalysis_CSharp_Syntax_ExpressionSyntax_Microsoft_CodeAnalysis_SyntaxToken_) | | + +## SuppressNullableWarningExpression\(ExpressionSyntax\) + +```csharp +public static Microsoft.CodeAnalysis.CSharp.Syntax.PostfixUnaryExpressionSyntax SuppressNullableWarningExpression(Microsoft.CodeAnalysis.CSharp.Syntax.ExpressionSyntax operand) +``` + +### Parameters + +**operand**   [ExpressionSyntax](https://docs.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.csharp.syntax.expressionsyntax) + +### Returns + +[PostfixUnaryExpressionSyntax](https://docs.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.csharp.syntax.postfixunaryexpressionsyntax) + +## SuppressNullableWarningExpression\(ExpressionSyntax, SyntaxToken\) + +```csharp +public static Microsoft.CodeAnalysis.CSharp.Syntax.PostfixUnaryExpressionSyntax SuppressNullableWarningExpression(Microsoft.CodeAnalysis.CSharp.Syntax.ExpressionSyntax operand, Microsoft.CodeAnalysis.SyntaxToken operatorToken) +``` + +### Parameters + +**operand**   [ExpressionSyntax](https://docs.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.csharp.syntax.expressionsyntax) + +**operatorToken**   [SyntaxToken](https://docs.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.syntaxtoken) + +### Returns + +[PostfixUnaryExpressionSyntax](https://docs.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.csharp.syntax.postfixunaryexpressionsyntax) + diff --git a/docs/api/Roslynator/CSharp/README.md b/docs/api/Roslynator/CSharp/README.md index 071b5ca4ac..204c1f5f7c 100644 --- a/docs/api/Roslynator/CSharp/README.md +++ b/docs/api/Roslynator/CSharp/README.md @@ -20,7 +20,9 @@ | [SyntaxAccessibility](SyntaxAccessibility/README.md) | A set of static methods that are related to C\# accessibility\. | | [SyntaxExtensions](SyntaxExtensions/README.md) | A set of extension methods for syntax \(types derived from [CSharpSyntaxNode](https://docs.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.csharp.csharpsyntaxnode)\)\. | | [SyntaxInfo](SyntaxInfo/README.md) | Serves as a factory for types in Roslynator\.CSharp\.Syntax namespace\. | -| [SyntaxInverter](SyntaxInverter/README.md) | Provides static methods for syntax inversion\. | +| [SyntaxInverter](SyntaxInverter/README.md) | \[deprecated\] | +| [SyntaxLogicalInverter](SyntaxLogicalInverter/README.md) | Provides static methods for syntax inversion\. | +| [SyntaxLogicalInverterOptions](SyntaxLogicalInverterOptions/README.md) | | | [WorkspaceExtensions](WorkspaceExtensions/README.md) | A set of extension methods for the workspace layer\. | | [WorkspaceSymbolExtensions](WorkspaceSymbolExtensions/README.md) | | | [WorkspaceSyntaxExtensions](WorkspaceSyntaxExtensions/README.md) | A set of extension methods for syntax\. These methods are dependent on the workspace layer\. | diff --git a/docs/api/Roslynator/CSharp/SyntaxInverter/README.md b/docs/api/Roslynator/CSharp/SyntaxInverter/README.md index 52fbfade14..138fe21b6f 100644 --- a/docs/api/Roslynator/CSharp/SyntaxInverter/README.md +++ b/docs/api/Roslynator/CSharp/SyntaxInverter/README.md @@ -6,13 +6,19 @@ **Assembly**: Roslynator\.CSharp\.Workspaces\.dll -\ -Provides static methods for syntax inversion\. +**WARNING: This API is now obsolete\.** + +SyntaxInverter is obsolete, use SyntaxLogicalInverter instead\. ```csharp +[Obsolete("SyntaxInverter is obsolete, use SyntaxLogicalInverter instead.")] public static class SyntaxInverter ``` +### Attributes + +* [ObsoleteAttribute](https://docs.microsoft.com/en-us/dotnet/api/system.obsoleteattribute) + ## Methods | Method | Summary | diff --git a/docs/api/Roslynator/CSharp/SyntaxLogicalInverter/-ctor/README.md b/docs/api/Roslynator/CSharp/SyntaxLogicalInverter/-ctor/README.md new file mode 100644 index 0000000000..8dbd019034 --- /dev/null +++ b/docs/api/Roslynator/CSharp/SyntaxLogicalInverter/-ctor/README.md @@ -0,0 +1,15 @@ +# SyntaxLogicalInverter\(SyntaxLogicalInverterOptions\) Constructor + +[Home](../../../../README.md) + +**Containing Type**: [SyntaxLogicalInverter](../README.md) + +**Assembly**: Roslynator\.CSharp\.Workspaces\.dll + +```csharp +public SyntaxLogicalInverter(Roslynator.CSharp.SyntaxLogicalInverterOptions options) +``` + +### Parameters + +**options**   [SyntaxLogicalInverterOptions](../../SyntaxLogicalInverterOptions/README.md) \ No newline at end of file diff --git a/docs/api/Roslynator/CSharp/SyntaxLogicalInverter/Default/README.md b/docs/api/Roslynator/CSharp/SyntaxLogicalInverter/Default/README.md new file mode 100644 index 0000000000..bab45f79f4 --- /dev/null +++ b/docs/api/Roslynator/CSharp/SyntaxLogicalInverter/Default/README.md @@ -0,0 +1,16 @@ +# SyntaxLogicalInverter\.Default Property + +[Home](../../../../README.md) + +**Containing Type**: [SyntaxLogicalInverter](../README.md) + +**Assembly**: Roslynator\.CSharp\.Workspaces\.dll + +```csharp +public static Roslynator.CSharp.SyntaxLogicalInverter Default { get; } +``` + +### Property Value + +[SyntaxLogicalInverter](../README.md) + diff --git a/docs/api/Roslynator/CSharp/SyntaxLogicalInverter/LogicallyInvert/README.md b/docs/api/Roslynator/CSharp/SyntaxLogicalInverter/LogicallyInvert/README.md new file mode 100644 index 0000000000..fd49f5e535 --- /dev/null +++ b/docs/api/Roslynator/CSharp/SyntaxLogicalInverter/LogicallyInvert/README.md @@ -0,0 +1,55 @@ +# SyntaxLogicalInverter\.LogicallyInvert Method + +[Home](../../../../README.md) + +**Containing Type**: [SyntaxLogicalInverter](../README.md) + +**Assembly**: Roslynator\.CSharp\.Workspaces\.dll + +## Overloads + +| Method | Summary | +| ------ | ------- | +| [LogicallyInvert(ExpressionSyntax, CancellationToken)](#Roslynator_CSharp_SyntaxLogicalInverter_LogicallyInvert_Microsoft_CodeAnalysis_CSharp_Syntax_ExpressionSyntax_System_Threading_CancellationToken_) | Returns new expression that represents logical inversion of the specified expression\. | +| [LogicallyInvert(ExpressionSyntax, SemanticModel, CancellationToken)](#Roslynator_CSharp_SyntaxLogicalInverter_LogicallyInvert_Microsoft_CodeAnalysis_CSharp_Syntax_ExpressionSyntax_Microsoft_CodeAnalysis_SemanticModel_System_Threading_CancellationToken_) | Returns new expression that represents logical inversion of the specified expression\. | + +## LogicallyInvert\(ExpressionSyntax, CancellationToken\) + +\ +Returns new expression that represents logical inversion of the specified expression\. + +```csharp +public Microsoft.CodeAnalysis.CSharp.Syntax.ExpressionSyntax LogicallyInvert(Microsoft.CodeAnalysis.CSharp.Syntax.ExpressionSyntax expression, System.Threading.CancellationToken cancellationToken = default) +``` + +### Parameters + +**expression**   [ExpressionSyntax](https://docs.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.csharp.syntax.expressionsyntax) + +**cancellationToken**   [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken) + +### Returns + +[ExpressionSyntax](https://docs.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.csharp.syntax.expressionsyntax) + +## LogicallyInvert\(ExpressionSyntax, SemanticModel, CancellationToken\) + +\ +Returns new expression that represents logical inversion of the specified expression\. + +```csharp +public Microsoft.CodeAnalysis.CSharp.Syntax.ExpressionSyntax LogicallyInvert(Microsoft.CodeAnalysis.CSharp.Syntax.ExpressionSyntax expression, Microsoft.CodeAnalysis.SemanticModel semanticModel, System.Threading.CancellationToken cancellationToken = default) +``` + +### Parameters + +**expression**   [ExpressionSyntax](https://docs.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.csharp.syntax.expressionsyntax) + +**semanticModel**   [SemanticModel](https://docs.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.semanticmodel) + +**cancellationToken**   [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken) + +### Returns + +[ExpressionSyntax](https://docs.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.csharp.syntax.expressionsyntax) + diff --git a/docs/api/Roslynator/CSharp/SyntaxLogicalInverter/Options/README.md b/docs/api/Roslynator/CSharp/SyntaxLogicalInverter/Options/README.md new file mode 100644 index 0000000000..c51618281c --- /dev/null +++ b/docs/api/Roslynator/CSharp/SyntaxLogicalInverter/Options/README.md @@ -0,0 +1,16 @@ +# SyntaxLogicalInverter\.Options Property + +[Home](../../../../README.md) + +**Containing Type**: [SyntaxLogicalInverter](../README.md) + +**Assembly**: Roslynator\.CSharp\.Workspaces\.dll + +```csharp +public Roslynator.CSharp.SyntaxLogicalInverterOptions Options { get; } +``` + +### Property Value + +[SyntaxLogicalInverterOptions](../../SyntaxLogicalInverterOptions/README.md) + diff --git a/docs/api/Roslynator/CSharp/SyntaxLogicalInverter/README.md b/docs/api/Roslynator/CSharp/SyntaxLogicalInverter/README.md new file mode 100644 index 0000000000..68034a3d53 --- /dev/null +++ b/docs/api/Roslynator/CSharp/SyntaxLogicalInverter/README.md @@ -0,0 +1,44 @@ +# SyntaxLogicalInverter Class + +[Home](../../../README.md) • [Constructors](#constructors) • [Properties](#properties) • [Methods](#methods) + +**Namespace**: [Roslynator.CSharp](../README.md) + +**Assembly**: Roslynator\.CSharp\.Workspaces\.dll + +\ +Provides static methods for syntax inversion\. + +```csharp +public class SyntaxLogicalInverter +``` + +### Inheritance + +[Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → SyntaxLogicalInverter + +## Constructors + +| Constructor | Summary | +| ----------- | ------- | +| [SyntaxLogicalInverter(SyntaxLogicalInverterOptions)](-ctor/README.md) | | + +## Properties + +| Property | Summary | +| -------- | ------- | +| [Default](Default/README.md) | | +| [Options](Options/README.md) | | + +## Methods + +| Method | Summary | +| ------ | ------- | +| [Equals(Object)](https://docs.microsoft.com/en-us/dotnet/api/system.object.equals) | \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) | +| [GetHashCode()](https://docs.microsoft.com/en-us/dotnet/api/system.object.gethashcode) | \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) | +| [GetType()](https://docs.microsoft.com/en-us/dotnet/api/system.object.gettype) | \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) | +| [LogicallyInvert(ExpressionSyntax, CancellationToken)](LogicallyInvert/README.md#Roslynator_CSharp_SyntaxLogicalInverter_LogicallyInvert_Microsoft_CodeAnalysis_CSharp_Syntax_ExpressionSyntax_System_Threading_CancellationToken_) | Returns new expression that represents logical inversion of the specified expression\. | +| [LogicallyInvert(ExpressionSyntax, SemanticModel, CancellationToken)](LogicallyInvert/README.md#Roslynator_CSharp_SyntaxLogicalInverter_LogicallyInvert_Microsoft_CodeAnalysis_CSharp_Syntax_ExpressionSyntax_Microsoft_CodeAnalysis_SemanticModel_System_Threading_CancellationToken_) | Returns new expression that represents logical inversion of the specified expression\. | +| [MemberwiseClone()](https://docs.microsoft.com/en-us/dotnet/api/system.object.memberwiseclone) | \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) | +| [ToString()](https://docs.microsoft.com/en-us/dotnet/api/system.object.tostring) | \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) | + diff --git a/docs/api/Roslynator/CSharp/SyntaxLogicalInverterOptions/-ctor/README.md b/docs/api/Roslynator/CSharp/SyntaxLogicalInverterOptions/-ctor/README.md new file mode 100644 index 0000000000..e5679c309d --- /dev/null +++ b/docs/api/Roslynator/CSharp/SyntaxLogicalInverterOptions/-ctor/README.md @@ -0,0 +1,15 @@ +# SyntaxLogicalInverterOptions\(Boolean\) Constructor + +[Home](../../../../README.md) + +**Containing Type**: [SyntaxLogicalInverterOptions](../README.md) + +**Assembly**: Roslynator\.CSharp\.Workspaces\.dll + +```csharp +public SyntaxLogicalInverterOptions(bool useNotPattern = true) +``` + +### Parameters + +**useNotPattern**   [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean) \ No newline at end of file diff --git a/docs/api/Roslynator/CSharp/SyntaxLogicalInverterOptions/Default/README.md b/docs/api/Roslynator/CSharp/SyntaxLogicalInverterOptions/Default/README.md new file mode 100644 index 0000000000..d2270fa629 --- /dev/null +++ b/docs/api/Roslynator/CSharp/SyntaxLogicalInverterOptions/Default/README.md @@ -0,0 +1,16 @@ +# SyntaxLogicalInverterOptions\.Default Property + +[Home](../../../../README.md) + +**Containing Type**: [SyntaxLogicalInverterOptions](../README.md) + +**Assembly**: Roslynator\.CSharp\.Workspaces\.dll + +```csharp +public static Roslynator.CSharp.SyntaxLogicalInverterOptions Default { get; } +``` + +### Property Value + +[SyntaxLogicalInverterOptions](../README.md) + diff --git a/docs/api/Roslynator/CSharp/SyntaxLogicalInverterOptions/README.md b/docs/api/Roslynator/CSharp/SyntaxLogicalInverterOptions/README.md new file mode 100644 index 0000000000..b770ea914c --- /dev/null +++ b/docs/api/Roslynator/CSharp/SyntaxLogicalInverterOptions/README.md @@ -0,0 +1,39 @@ +# SyntaxLogicalInverterOptions Class + +[Home](../../../README.md) • [Constructors](#constructors) • [Properties](#properties) • [Methods](#methods) + +**Namespace**: [Roslynator.CSharp](../README.md) + +**Assembly**: Roslynator\.CSharp\.Workspaces\.dll + +```csharp +public class SyntaxLogicalInverterOptions +``` + +### Inheritance + +[Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → SyntaxLogicalInverterOptions + +## Constructors + +| Constructor | Summary | +| ----------- | ------- | +| [SyntaxLogicalInverterOptions(Boolean)](-ctor/README.md) | | + +## Properties + +| Property | Summary | +| -------- | ------- | +| [Default](Default/README.md) | | +| [UseNotPattern](UseNotPattern/README.md) | | + +## Methods + +| Method | Summary | +| ------ | ------- | +| [Equals(Object)](https://docs.microsoft.com/en-us/dotnet/api/system.object.equals) | \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) | +| [GetHashCode()](https://docs.microsoft.com/en-us/dotnet/api/system.object.gethashcode) | \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) | +| [GetType()](https://docs.microsoft.com/en-us/dotnet/api/system.object.gettype) | \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) | +| [MemberwiseClone()](https://docs.microsoft.com/en-us/dotnet/api/system.object.memberwiseclone) | \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) | +| [ToString()](https://docs.microsoft.com/en-us/dotnet/api/system.object.tostring) | \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) | + diff --git a/docs/api/Roslynator/CSharp/SyntaxLogicalInverterOptions/UseNotPattern/README.md b/docs/api/Roslynator/CSharp/SyntaxLogicalInverterOptions/UseNotPattern/README.md new file mode 100644 index 0000000000..8b3a7ccb6c --- /dev/null +++ b/docs/api/Roslynator/CSharp/SyntaxLogicalInverterOptions/UseNotPattern/README.md @@ -0,0 +1,16 @@ +# SyntaxLogicalInverterOptions\.UseNotPattern Property + +[Home](../../../../README.md) + +**Containing Type**: [SyntaxLogicalInverterOptions](../README.md) + +**Assembly**: Roslynator\.CSharp\.Workspaces\.dll + +```csharp +public bool UseNotPattern { get; } +``` + +### Property Value + +[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean) + diff --git a/docs/api/Roslynator/SymbolExtensions/EqualsOrInheritsFrom/README.md b/docs/api/Roslynator/SymbolExtensions/EqualsOrInheritsFrom/README.md index 035c5bbfe2..983516297e 100644 --- a/docs/api/Roslynator/SymbolExtensions/EqualsOrInheritsFrom/README.md +++ b/docs/api/Roslynator/SymbolExtensions/EqualsOrInheritsFrom/README.md @@ -11,7 +11,7 @@ | Method | Summary | | ------ | ------- | | [EqualsOrInheritsFrom(ITypeSymbol, ITypeSymbol, Boolean)](#Roslynator_SymbolExtensions_EqualsOrInheritsFrom_Microsoft_CodeAnalysis_ITypeSymbol_Microsoft_CodeAnalysis_ITypeSymbol_System_Boolean_) | Returns true if the type is equal or inherits from a specified base type\. | -| [EqualsOrInheritsFrom(ITypeSymbol, MetadataName, Boolean)](#Roslynator_SymbolExtensions_EqualsOrInheritsFrom_Microsoft_CodeAnalysis_ITypeSymbol_Roslynator_MetadataName__System_Boolean_) | Returns true if the type is equal or inherits from a type wit the specified name\. | +| [EqualsOrInheritsFrom(ITypeSymbol, MetadataName, Boolean)](#Roslynator_SymbolExtensions_EqualsOrInheritsFrom_Microsoft_CodeAnalysis_ITypeSymbol_Roslynator_MetadataName__System_Boolean_) | Returns true if the type is equal or inherits from a type with the specified name\. | ## EqualsOrInheritsFrom\(ITypeSymbol, ITypeSymbol, Boolean\) @@ -37,7 +37,7 @@ public static bool EqualsOrInheritsFrom(this Microsoft.CodeAnalysis.ITypeSymbol ## EqualsOrInheritsFrom\(ITypeSymbol, MetadataName, Boolean\) \ -Returns true if the type is equal or inherits from a type wit the specified name\. +Returns true if the type is equal or inherits from a type with the specified name\. ```csharp public static bool EqualsOrInheritsFrom(this Microsoft.CodeAnalysis.ITypeSymbol type, in Roslynator.MetadataName baseTypeName, bool includeInterfaces = false) diff --git a/docs/api/Roslynator/SymbolExtensions/README.md b/docs/api/Roslynator/SymbolExtensions/README.md index eda877845c..aad4cd604c 100644 --- a/docs/api/Roslynator/SymbolExtensions/README.md +++ b/docs/api/Roslynator/SymbolExtensions/README.md @@ -20,7 +20,7 @@ public static class SymbolExtensions | [BaseTypes(ITypeSymbol)](BaseTypes/README.md) | Gets a list of base types of this type\. | | [BaseTypesAndSelf(ITypeSymbol)](BaseTypesAndSelf/README.md) | Gets a list of base types of this type \(including this type\)\. | | [EqualsOrInheritsFrom(ITypeSymbol, ITypeSymbol, Boolean)](EqualsOrInheritsFrom/README.md#Roslynator_SymbolExtensions_EqualsOrInheritsFrom_Microsoft_CodeAnalysis_ITypeSymbol_Microsoft_CodeAnalysis_ITypeSymbol_System_Boolean_) | Returns true if the type is equal or inherits from a specified base type\. | -| [EqualsOrInheritsFrom(ITypeSymbol, MetadataName, Boolean)](EqualsOrInheritsFrom/README.md#Roslynator_SymbolExtensions_EqualsOrInheritsFrom_Microsoft_CodeAnalysis_ITypeSymbol_Roslynator_MetadataName__System_Boolean_) | Returns true if the type is equal or inherits from a type wit the specified name\. | +| [EqualsOrInheritsFrom(ITypeSymbol, MetadataName, Boolean)](EqualsOrInheritsFrom/README.md#Roslynator_SymbolExtensions_EqualsOrInheritsFrom_Microsoft_CodeAnalysis_ITypeSymbol_Roslynator_MetadataName__System_Boolean_) | Returns true if the type is equal or inherits from a type with the specified name\. | | [FindMember\(INamedTypeSymbol, Func\, Boolean)](FindMember-1/README.md#Roslynator_SymbolExtensions_FindMember__1_Microsoft_CodeAnalysis_INamedTypeSymbol_System_Func___0_System_Boolean__System_Boolean_) | Searches for a member that matches the conditions defined by the specified predicate and returns the first occurrence within the type's members\. | | [FindMember\(INamedTypeSymbol, String, Func\, Boolean)](FindMember-1/README.md#Roslynator_SymbolExtensions_FindMember__1_Microsoft_CodeAnalysis_INamedTypeSymbol_System_String_System_Func___0_System_Boolean__System_Boolean_) | Searches for a member that has the specified name and matches the conditions defined by the specified predicate, if any, and returns the first occurrence within the type's members\. | | [FindMember\(ITypeSymbol, Func\)](FindMember-1/README.md#Roslynator_SymbolExtensions_FindMember__1_Microsoft_CodeAnalysis_ITypeSymbol_System_Func___0_System_Boolean__) | Searches for a member that matches the conditions defined by the specified predicate, if any, and returns the first occurrence within the type's members\. | diff --git a/docs/api/Roslynator/Testing/CSharp/CSharpTestOptions/-ctor/README.md b/docs/api/Roslynator/Testing/CSharp/CSharpTestOptions/-ctor/README.md index 403967d2cd..d5ac43c8e7 100644 --- a/docs/api/Roslynator/Testing/CSharp/CSharpTestOptions/-ctor/README.md +++ b/docs/api/Roslynator/Testing/CSharp/CSharpTestOptions/-ctor/README.md @@ -1,4 +1,4 @@ -# CSharpTestOptions\(CSharpCompilationOptions, CSharpParseOptions, IEnumerable\, IEnumerable\, DiagnosticSeverity\) Constructor +# CSharpTestOptions\(CSharpCompilationOptions, CSharpParseOptions, IEnumerable\, IEnumerable\, DiagnosticSeverity, IEnumerable\>\) Constructor [Home](../../../../../README.md) @@ -10,7 +10,7 @@ Initializes a new instance of [CSharpTestOptions](../README.md)\. ```csharp -public CSharpTestOptions(Microsoft.CodeAnalysis.CSharp.CSharpCompilationOptions compilationOptions = null, Microsoft.CodeAnalysis.CSharp.CSharpParseOptions parseOptions = null, System.Collections.Generic.IEnumerable metadataReferences = null, System.Collections.Generic.IEnumerable allowedCompilerDiagnosticIds = null, Microsoft.CodeAnalysis.DiagnosticSeverity allowedCompilerDiagnosticSeverity = Info) +public CSharpTestOptions(Microsoft.CodeAnalysis.CSharp.CSharpCompilationOptions compilationOptions = null, Microsoft.CodeAnalysis.CSharp.CSharpParseOptions parseOptions = null, System.Collections.Generic.IEnumerable metadataReferences = null, System.Collections.Generic.IEnumerable allowedCompilerDiagnosticIds = null, Microsoft.CodeAnalysis.DiagnosticSeverity allowedCompilerDiagnosticSeverity = Info, System.Collections.Generic.IEnumerable> configOptions = null) ``` ### Parameters @@ -23,4 +23,6 @@ public CSharpTestOptions(Microsoft.CodeAnalysis.CSharp.CSharpCompilationOptions **allowedCompilerDiagnosticIds**   [IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)\<[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)> -**allowedCompilerDiagnosticSeverity**   [DiagnosticSeverity](https://docs.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.diagnosticseverity) \ No newline at end of file +**allowedCompilerDiagnosticSeverity**   [DiagnosticSeverity](https://docs.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.diagnosticseverity) + +**configOptions**   [IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)\<[KeyValuePair](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.keyvaluepair-2)\<[String](https://docs.microsoft.com/en-us/dotnet/api/system.string), [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)>> \ No newline at end of file diff --git a/docs/api/Roslynator/Testing/CSharp/CSharpTestOptions/CommonWithConfigOptions/README.md b/docs/api/Roslynator/Testing/CSharp/CSharpTestOptions/CommonWithConfigOptions/README.md new file mode 100644 index 0000000000..1d9d7336a0 --- /dev/null +++ b/docs/api/Roslynator/Testing/CSharp/CSharpTestOptions/CommonWithConfigOptions/README.md @@ -0,0 +1,20 @@ +# CSharpTestOptions\.CommonWithConfigOptions\(IEnumerable\>\) Method + +[Home](../../../../../README.md) + +**Containing Type**: [CSharpTestOptions](../README.md) + +**Assembly**: Roslynator\.Testing\.CSharp\.dll + +```csharp +protected override Roslynator.Testing.TestOptions CommonWithConfigOptions(System.Collections.Generic.IEnumerable> values) +``` + +### Parameters + +**values**   [IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)\<[KeyValuePair](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.keyvaluepair-2)\<[String](https://docs.microsoft.com/en-us/dotnet/api/system.string), [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)>> + +### Returns + +[TestOptions](../../../TestOptions/README.md) + diff --git a/docs/api/Roslynator/Testing/CSharp/CSharpTestOptions/README.md b/docs/api/Roslynator/Testing/CSharp/CSharpTestOptions/README.md index 85c6e2fc97..5efc816c0d 100644 --- a/docs/api/Roslynator/Testing/CSharp/CSharpTestOptions/README.md +++ b/docs/api/Roslynator/Testing/CSharp/CSharpTestOptions/README.md @@ -21,7 +21,7 @@ public sealed class CSharpTestOptions : Roslynator.Testing.TestOptions | Constructor | Summary | | ----------- | ------- | -| [CSharpTestOptions(CSharpCompilationOptions, CSharpParseOptions, IEnumerable\, IEnumerable\, DiagnosticSeverity)](-ctor/README.md) | Initializes a new instance of [CSharpTestOptions](./README.md)\. | +| [CSharpTestOptions(CSharpCompilationOptions, CSharpParseOptions, IEnumerable\, IEnumerable\, DiagnosticSeverity, IEnumerable\>)](-ctor/README.md) | Initializes a new instance of [CSharpTestOptions](./README.md)\. | ## Properties @@ -32,6 +32,7 @@ public sealed class CSharpTestOptions : Roslynator.Testing.TestOptions | [CommonCompilationOptions](CommonCompilationOptions/README.md) | Gets a common compilation options\. \(Overrides [TestOptions.CommonCompilationOptions](../../TestOptions/CommonCompilationOptions/README.md)\) | | [CommonParseOptions](CommonParseOptions/README.md) | Gets a common parse options\. \(Overrides [TestOptions.CommonParseOptions](../../TestOptions/CommonParseOptions/README.md)\) | | [CompilationOptions](CompilationOptions/README.md) | Gets a compilation options that should be used to compile test project\. | +| [ConfigOptions](../../TestOptions/ConfigOptions/README.md) | Gets a collection of config options\. \(Inherited from [TestOptions](../../TestOptions/README.md)\) | | [Default](Default/README.md) | Gets a default code verification options\. | | [Language](Language/README.md) | Gets C\# programming language identifier\. \(Overrides [TestOptions.Language](../../TestOptions/Language/README.md)\) | | [MetadataReferences](../../TestOptions/MetadataReferences/README.md) | Gets metadata references of a test project\. \(Inherited from [TestOptions](../../TestOptions/README.md)\) | @@ -45,6 +46,7 @@ public sealed class CSharpTestOptions : Roslynator.Testing.TestOptions | [AddAllowedCompilerDiagnosticIds(IEnumerable\)](AddAllowedCompilerDiagnosticIds/README.md) | Adds a list of specified compiler diagnostic IDs to the list of allowed compiler diagnostic IDs\. | | [CommonWithAllowedCompilerDiagnosticIds(IEnumerable\)](CommonWithAllowedCompilerDiagnosticIds/README.md) | \(Overrides [TestOptions.CommonWithAllowedCompilerDiagnosticIds](../../TestOptions/CommonWithAllowedCompilerDiagnosticIds/README.md)\) | | [CommonWithAllowedCompilerDiagnosticSeverity(DiagnosticSeverity)](CommonWithAllowedCompilerDiagnosticSeverity/README.md) | \(Overrides [TestOptions.CommonWithAllowedCompilerDiagnosticSeverity](../../TestOptions/CommonWithAllowedCompilerDiagnosticSeverity/README.md)\) | +| [CommonWithConfigOptions(IEnumerable\>)](CommonWithConfigOptions/README.md) | \(Overrides [TestOptions.CommonWithConfigOptions](../../TestOptions/CommonWithConfigOptions/README.md)\) | | [CommonWithMetadataReferences(IEnumerable\)](CommonWithMetadataReferences/README.md) | \(Overrides [TestOptions.CommonWithMetadataReferences](../../TestOptions/CommonWithMetadataReferences/README.md)\) | | [Equals(Object)](https://docs.microsoft.com/en-us/dotnet/api/system.object.equals) | \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) | | [GetHashCode()](https://docs.microsoft.com/en-us/dotnet/api/system.object.gethashcode) | \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) | @@ -54,6 +56,7 @@ public sealed class CSharpTestOptions : Roslynator.Testing.TestOptions | [WithAllowedCompilerDiagnosticIds(IEnumerable\)](WithAllowedCompilerDiagnosticIds/README.md) | | | [WithAllowedCompilerDiagnosticSeverity(DiagnosticSeverity)](WithAllowedCompilerDiagnosticSeverity/README.md) | | | [WithCompilationOptions(CSharpCompilationOptions)](WithCompilationOptions/README.md) | | +| [WithConfigOptions(IEnumerable\>)](WithConfigOptions/README.md) | | | [WithMetadataReferences(IEnumerable\)](WithMetadataReferences/README.md) | | | [WithParseOptions(CSharpParseOptions)](WithParseOptions/README.md) | | diff --git a/docs/api/Roslynator/Testing/CSharp/CSharpTestOptions/WithConfigOptions/README.md b/docs/api/Roslynator/Testing/CSharp/CSharpTestOptions/WithConfigOptions/README.md new file mode 100644 index 0000000000..6eedd5914b --- /dev/null +++ b/docs/api/Roslynator/Testing/CSharp/CSharpTestOptions/WithConfigOptions/README.md @@ -0,0 +1,20 @@ +# CSharpTestOptions\.WithConfigOptions\(IEnumerable\>\) Method + +[Home](../../../../../README.md) + +**Containing Type**: [CSharpTestOptions](../README.md) + +**Assembly**: Roslynator\.Testing\.CSharp\.dll + +```csharp +public Roslynator.Testing.CSharp.CSharpTestOptions WithConfigOptions(System.Collections.Generic.IEnumerable> values) +``` + +### Parameters + +**values**   [IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)\<[KeyValuePair](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.keyvaluepair-2)\<[String](https://docs.microsoft.com/en-us/dotnet/api/system.string), [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)>> + +### Returns + +[CSharpTestOptions](../README.md) + diff --git a/docs/api/Roslynator/Testing/TestOptions/CommonWithConfigOptions/README.md b/docs/api/Roslynator/Testing/TestOptions/CommonWithConfigOptions/README.md new file mode 100644 index 0000000000..50487473a1 --- /dev/null +++ b/docs/api/Roslynator/Testing/TestOptions/CommonWithConfigOptions/README.md @@ -0,0 +1,20 @@ +# TestOptions\.CommonWithConfigOptions\(IEnumerable\>\) Method + +[Home](../../../../README.md) + +**Containing Type**: [TestOptions](../README.md) + +**Assembly**: Roslynator\.Testing\.Common\.dll + +```csharp +protected abstract Roslynator.Testing.TestOptions CommonWithConfigOptions(System.Collections.Generic.IEnumerable> values) +``` + +### Parameters + +**values**   [IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)\<[KeyValuePair](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.keyvaluepair-2)\<[String](https://docs.microsoft.com/en-us/dotnet/api/system.string), [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)>> + +### Returns + +[TestOptions](../README.md) + diff --git a/docs/api/Roslynator/Testing/TestOptions/ConfigOptions/README.md b/docs/api/Roslynator/Testing/TestOptions/ConfigOptions/README.md new file mode 100644 index 0000000000..9be32b2574 --- /dev/null +++ b/docs/api/Roslynator/Testing/TestOptions/ConfigOptions/README.md @@ -0,0 +1,19 @@ +# TestOptions\.ConfigOptions Property + +[Home](../../../../README.md) + +**Containing Type**: [TestOptions](../README.md) + +**Assembly**: Roslynator\.Testing\.Common\.dll + +\ +Gets a collection of config options\. + +```csharp +public System.Collections.Immutable.ImmutableDictionary ConfigOptions { get; protected set; } +``` + +### Property Value + +[ImmutableDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.immutable.immutabledictionary-2)\<[String](https://docs.microsoft.com/en-us/dotnet/api/system.string), [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)> + diff --git a/docs/api/Roslynator/Testing/TestOptions/README.md b/docs/api/Roslynator/Testing/TestOptions/README.md index df90512269..565779e7b4 100644 --- a/docs/api/Roslynator/Testing/TestOptions/README.md +++ b/docs/api/Roslynator/Testing/TestOptions/README.md @@ -30,6 +30,7 @@ public abstract class TestOptions | [CommonCompilationOptions](CommonCompilationOptions/README.md) | Gets a common compilation options\. | | [CommonParseOptions](CommonParseOptions/README.md) | Gets a common parse options\. | | [CompilationOptions](CompilationOptions/README.md) | Gets a compilation options that should be used to compile test project\. | +| [ConfigOptions](ConfigOptions/README.md) | Gets a collection of config options\. | | [Language](Language/README.md) | Gets a programming language identifier\. | | [MetadataReferences](MetadataReferences/README.md) | Gets metadata references of a test project\. | | [ParseOptions](ParseOptions/README.md) | Gets a parse options that should be used to parse tested source code\. | @@ -40,6 +41,7 @@ public abstract class TestOptions | ------ | ------- | | [CommonWithAllowedCompilerDiagnosticIds(IEnumerable\)](CommonWithAllowedCompilerDiagnosticIds/README.md) | | | [CommonWithAllowedCompilerDiagnosticSeverity(DiagnosticSeverity)](CommonWithAllowedCompilerDiagnosticSeverity/README.md) | | +| [CommonWithConfigOptions(IEnumerable\>)](CommonWithConfigOptions/README.md) | | | [CommonWithMetadataReferences(IEnumerable\)](CommonWithMetadataReferences/README.md) | | | [Equals(Object)](https://docs.microsoft.com/en-us/dotnet/api/system.object.equals) | \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) | | [GetHashCode()](https://docs.microsoft.com/en-us/dotnet/api/system.object.gethashcode) | \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) | @@ -48,5 +50,6 @@ public abstract class TestOptions | [ToString()](https://docs.microsoft.com/en-us/dotnet/api/system.object.tostring) | \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) | | [WithAllowedCompilerDiagnosticIds(IEnumerable\)](WithAllowedCompilerDiagnosticIds/README.md) | | | [WithAllowedCompilerDiagnosticSeverity(DiagnosticSeverity)](WithAllowedCompilerDiagnosticSeverity/README.md) | | +| [WithConfigOptions(IEnumerable\>)](WithConfigOptions/README.md) | | | [WithMetadataReferences(IEnumerable\)](WithMetadataReferences/README.md) | | diff --git a/docs/api/Roslynator/Testing/TestOptions/WithConfigOptions/README.md b/docs/api/Roslynator/Testing/TestOptions/WithConfigOptions/README.md new file mode 100644 index 0000000000..617120b503 --- /dev/null +++ b/docs/api/Roslynator/Testing/TestOptions/WithConfigOptions/README.md @@ -0,0 +1,20 @@ +# TestOptions\.WithConfigOptions\(IEnumerable\>\) Method + +[Home](../../../../README.md) + +**Containing Type**: [TestOptions](../README.md) + +**Assembly**: Roslynator\.Testing\.Common\.dll + +```csharp +public Roslynator.Testing.TestOptions WithConfigOptions(System.Collections.Generic.IEnumerable> values) +``` + +### Parameters + +**values**   [IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)\<[KeyValuePair](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.keyvaluepair-2)\<[String](https://docs.microsoft.com/en-us/dotnet/api/system.string), [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)>> + +### Returns + +[TestOptions](../README.md) + diff --git a/src/CSharp.Workspaces/README.md b/src/CSharp.Workspaces/README.md index 7a3922921e..ac278d4956 100644 --- a/src/CSharp.Workspaces/README.md +++ b/src/CSharp.Workspaces/README.md @@ -1,16 +1,24 @@ # Roslynator\.CSharp\.Workspaces -[Namespaces](#namespaces) +[Namespaces](#namespaces) • [Class Hierarchy](#class-hierarchy) ## Namespaces * [Roslynator.CSharp](../../docs/api/Roslynator/CSharp/README.md) +## Class Hierarchy + +*   \([Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) +*   [•](#class-hierarchy-System_Object "Object")   [SyntaxLogicalInverter](../../docs/api/Roslynator/CSharp/SyntaxLogicalInverter/README.md) +*   [•](#class-hierarchy-System_Object "Object")   [SyntaxLogicalInverterOptions](../../docs/api/Roslynator/CSharp/SyntaxLogicalInverterOptions/README.md) + ## [Roslynator.CSharp](../../docs/api/Roslynator/CSharp/README.md) Namespace ### Classes -* [SyntaxInverter](../../docs/api/Roslynator/CSharp/SyntaxInverter/README.md) +* \[deprecated\] [SyntaxInverter](../../docs/api/Roslynator/CSharp/SyntaxInverter/README.md) +* [SyntaxLogicalInverter](../../docs/api/Roslynator/CSharp/SyntaxLogicalInverter/README.md) +* [SyntaxLogicalInverterOptions](../../docs/api/Roslynator/CSharp/SyntaxLogicalInverterOptions/README.md) * [WorkspaceExtensions](../../docs/api/Roslynator/CSharp/WorkspaceExtensions/README.md) * [WorkspaceSymbolExtensions](../../docs/api/Roslynator/CSharp/WorkspaceSymbolExtensions/README.md) * [WorkspaceSyntaxExtensions](../../docs/api/Roslynator/CSharp/WorkspaceSyntaxExtensions/README.md)