Skip to content

remove redundant xml comments from Analyser project #4636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

remove redundant xml comments from Analyser project #4636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f523a6
remove redundant xml comments from Analyser project
SimonCropp Apr 17, 2025
a22945c
remove more comments
SimonCropp Apr 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions ...la.Analyzers/Csla.Analyzers/AsynchronousBusinessRuleInheritingFromBusinessRuleAnalyzer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@

namespace Csla.Analyzers
{
/// <summary>
///
/// </summary>
[DiagnosticAnalyzer(LanguageNames.CSharp)]
public sealed class AsynchronousBusinessRuleInheritingFromBusinessRuleAnalyzer
: DiagnosticAnalyzer
Expand All @@ -23,15 +20,8 @@ public sealed class AsynchronousBusinessRuleInheritingFromBusinessRuleAnalyzer
helpLinkUri: HelpUrlBuilder.Build(
Constants.AnalyzerIdentifiers.AsynchronousBusinessRuleInheritance, nameof(AsynchronousBusinessRuleInheritingFromBusinessRuleAnalyzer)));

/// <summary>
///
/// </summary>
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => [inheritsFromBusinessRuleRule];

/// <summary>
///
/// </summary>
/// <param name="context"></param>
public override void Initialize(AnalysisContext context)
{
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.ReportDiagnostics);
Expand Down
15 changes: 0 additions & 15 deletions ...ers/Csla.Analyzers/AsynchronousBusinessRuleInheritingFromBusinessRuleAnalyzerConstants.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,14 @@

namespace Csla.Analyzers
{
/// <summary>
///
/// </summary>
public static class AsynchronousBusinessRuleInheritingFromBusinessRuleAnalyzerConstants
{
/// <summary>
///
/// </summary>
public static readonly LocalizableResourceString Title = new(nameof(Resources.AsynchronousBusinessRuleInheritingFromBusinessRuleAnalyzer_Title), Resources.ResourceManager, typeof(Resources));
/// <summary>
///
/// </summary>
public static readonly LocalizableResourceString Message = new(nameof(Resources.AsynchronousBusinessRuleInheritingFromBusinessRuleAnalyzer_Message), Resources.ResourceManager, typeof(Resources));
}

/// <summary>
///
/// </summary>
public static class AsynchronousBusinessRuleInheritingFromBusinessRuleChangeToBusinessRuleAsyncCodeFixConstants
{
/// <summary>
///
/// </summary>
public static string UpdateToAsyncEquivalentsDescription => Resources.AsynchronousBusinessRuleInheritingFromBusinessRuleAnalyzer_UpdateToAsyncEquivalentsDescription;
}
}
16 changes: 1 addition & 15 deletions ...ers/AsynchronousBusinessRuleInheritingFromBusinessRuleChangeToBusinessRuleAsyncCodeFix.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,29 +10,15 @@

namespace Csla.Analyzers
{
/// <summary>
///
/// </summary>
[ExportCodeFixProvider(LanguageNames.CSharp)]
[Shared]
public sealed class AsynchronousBusinessRuleInheritingFromBusinessRuleChangeToBusinessRuleAsyncCodeFix
: CodeFixProvider
{
/// <summary>
///
/// </summary>
public override ImmutableArray<string> FixableDiagnosticIds => [AnalyzerIdentifiers.AsynchronousBusinessRuleInheritance];

/// <summary>
///
/// </summary>
/// <returns></returns>
public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer;
/// <summary>
///
/// </summary>
/// <param name="context"></param>
/// <returns></returns>

public override async Task RegisterCodeFixesAsync(CodeFixContext context)
{
var root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false);
Expand Down
10 changes: 0 additions & 10 deletions Source/Csla.Analyzers/Csla.Analyzers/BusinessRuleDoesNotUseAddMethodsOnContextAnalyzer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@

namespace Csla.Analyzers
{
/// <summary>
///
/// </summary>
[DiagnosticAnalyzer(LanguageNames.CSharp)]
public sealed class BusinessRuleDoesNotUseAddMethodsOnContextAnalyzer
: DiagnosticAnalyzer
Expand All @@ -23,15 +20,8 @@ public sealed class BusinessRuleDoesNotUseAddMethodsOnContextAnalyzer
helpLinkUri: HelpUrlBuilder.Build(
Constants.AnalyzerIdentifiers.BusinessRuleContextUsage, nameof(BusinessRuleDoesNotUseAddMethodsOnContextAnalyzer)));

/// <summary>
///
/// </summary>
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => [usesAddMethodsOnContextRule];

/// <summary>
///
/// </summary>
/// <param name="context"></param>
public override void Initialize(AnalysisContext context)
{
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.ReportDiagnostics);
Expand Down
9 changes: 0 additions & 9 deletions ...la.Analyzers/Csla.Analyzers/BusinessRuleDoesNotUseAddMethodsOnContextAnalyzerConstants.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,9 @@

namespace Csla.Analyzers
{
/// <summary>
///
/// </summary>
public static class BusinessRuleDoesNotUseAddMethodsOnContextAnalyzerConstants
{
/// <summary>
///
/// </summary>
public static readonly LocalizableResourceString Title = new(nameof(Resources.BusinessRuleDoesNotUseAddMethodsOnContextAnalyzer_Title), Resources.ResourceManager, typeof(Resources));
/// <summary>
///
/// </summary>
public static readonly LocalizableResourceString Message = new(nameof(Resources.BusinessRuleDoesNotUseAddMethodsOnContextAnalyzer_Message), Resources.ResourceManager, typeof(Resources));
}
}
10 changes: 0 additions & 10 deletions Source/Csla.Analyzers/Csla.Analyzers/CheckConstructorsAnalyzer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@

namespace Csla.Analyzers
{
/// <summary>
///
/// </summary>
[DiagnosticAnalyzer(LanguageNames.CSharp)]
public sealed class CheckConstructorsAnalyzer
: DiagnosticAnalyzer
Expand All @@ -29,19 +26,12 @@ public sealed class CheckConstructorsAnalyzer
helpLinkUri: HelpUrlBuilder.Build(
Constants.AnalyzerIdentifiers.ConstructorHasParameters, nameof(CheckConstructorsAnalyzer)));

/// <summary>
///
/// </summary>
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics =>
[
publicNoArgumentConstructorIsMissingRule,
constructorHasParametersRule
];

/// <summary>
///
/// </summary>
/// <param name="context"></param>
public override void Initialize(AnalysisContext context)
{
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.ReportDiagnostics);
Expand Down
39 changes: 0 additions & 39 deletions Source/Csla.Analyzers/Csla.Analyzers/CheckConstructorsAnalyzerConstants.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,67 +3,28 @@

namespace Csla.Analyzers
{
/// <summary>
///
/// </summary>
public static class PublicNoArgumentConstructorIsMissingConstants
{
/// <summary>
///
/// </summary>
public const string HasNonPublicNoArgumentConstructor = "HasNonPublicNoArgumentConstructor";
/// <summary>
///
/// </summary>
public static readonly LocalizableResourceString Title = new(nameof(Resources.PublicNoArgumentConstructorIsMissing_Title), Resources.ResourceManager, typeof(Resources));
/// <summary>
///
/// </summary>
public static readonly LocalizableResourceString Message = new(nameof(Resources.PublicNoArgumentConstructorIsMissing_Message), Resources.ResourceManager, typeof(Resources));
}

/// <summary>
///
/// </summary>
public static class ConstructorHasParametersConstants
{
/// <summary>
///
/// </summary>
public static readonly LocalizableResourceString Title = new(nameof(Resources.ConstructorHasParameters_Title), Resources.ResourceManager, typeof(Resources));
/// <summary>
///
/// </summary>
public static readonly LocalizableResourceString Message = new(nameof(Resources.ConstructorHasParameters_Message), Resources.ResourceManager, typeof(Resources));
}

/// <summary>
///
/// </summary>
public static class FindBusinessObjectCreationConstants
{
/// <summary>
///
/// </summary>
public static readonly LocalizableResourceString Title = new(nameof(Resources.FindBusinessObjectCreationConstants_Title), Resources.ResourceManager, typeof(Resources));
/// <summary>
///
/// </summary>
public static readonly LocalizableResourceString Message = new(nameof(Resources.FindBusinessObjectCreationConstants_Message), Resources.ResourceManager, typeof(Resources));
}

/// <summary>
///
/// </summary>
public static class CheckConstructorsAnalyzerPublicConstructorCodeFixConstants
{
/// <summary>
///
/// </summary>
public static string AddPublicConstructorDescription => Resources.CheckConstructorsAnalyzerPublicConstructor_AddPublicConstructorDescription;
/// <summary>
///
/// </summary>
public static string UpdateNonPublicConstructorToPublicDescription => Resources.CheckConstructorsAnalyzerPublicConstructor_UpdateNonPublicConstructorToPublicDescription;
}
}
12 changes: 0 additions & 12 deletions Source/Csla.Analyzers/Csla.Analyzers/CheckConstructorsAnalyzerPublicConstructorCodeFix.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,15 @@

namespace Csla.Analyzers
{
/// <summary>
///
/// </summary>
[ExportCodeFixProvider(LanguageNames.CSharp)]
[Shared]
public sealed class CheckConstructorsAnalyzerPublicConstructorCodeFix
: CodeFixProvider
{
/// <summary>
///
/// </summary>
public override ImmutableArray<string> FixableDiagnosticIds => [Constants.AnalyzerIdentifiers.PublicNoArgumentConstructorIsMissing];

/// <summary>
///
/// </summary>
public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer;

/// <summary>
///
/// </summary>
public override async Task RegisterCodeFixesAsync(CodeFixContext context)
{
var root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false);
Expand Down
Loading
Loading