added quickfix xmldoc, R-W

Author: retailcoder

Rubberduck.CodeAnalysis/QuickFixes/RemoveAnnotationQuickFix.cs

@@ -6,6 +6,36 @@
 
 namespace Rubberduck.Inspections.QuickFixes
 {
+    /// <summary>
+    /// Removes an annotation comment representing a hidden module or member attribute, in order to maintain consistency between hidden attributes and annotation comments.
+    /// </summary>
+    /// <inspections>
+    /// <inspection name="MissingAttributeInspection" />
+    /// </inspections>
+    /// <canfix procedure="false" module="false" project="false" />
+    /// <example>
+    /// <before>
+    /// <![CDATA[
+    /// Attribute VB_PredeclaredId = False
+    /// '@PredeclaredId
+    /// 
+    /// Option Explicit
+    /// 
+    /// Public Sub DoSomething()
+    /// End Sub
+    /// ]]>
+    /// </before>
+    /// <after>
+    /// <![CDATA[
+    /// Attribute VB_PredeclaredId = False
+    /// 
+    /// Option Explicit
+    /// 
+    /// Public Sub DoSomething()
+    /// End Sub
+    /// ]]>
+    /// </after>
+    /// </example>
     public sealed class RemoveAnnotationQuickFix : QuickFixBase
     {
         private readonly IAnnotationUpdater _annotationUpdater; 

Rubberduck.CodeAnalysis/QuickFixes/RemoveAttributeQuickFix.cs

@@ -9,6 +9,35 @@
 
 namespace Rubberduck.Inspections.QuickFixes
 {
+    /// <summary>
+    /// Removes a hidden attribute, in order to maintain consistency between hidden attributes and (missing) annotation comments.
+    /// </summary>
+    /// <inspections>
+    /// <inspection name="MissingModuleAnnotationInspection" />
+    /// <inspection name="MissingMemberAnnotationInspection" />
+    /// </inspections>
+    /// <canfix procedure="false" module="false" project="false" />
+    /// <example>
+    /// <before>
+    /// <![CDATA[
+    /// Option Explicit
+    /// 
+    /// Public Sub DoSomething()
+    /// Attribute VB_UserMemId = 0
+    /// 
+    /// End Sub
+    /// ]]>
+    /// </before>
+    /// <after>
+    /// <![CDATA[
+    /// Option Explicit
+    /// 
+    /// Public Sub DoSomething()
+    /// 
+    /// End Sub
+    /// ]]>
+    /// </after>
+    /// </example>
     public class RemoveAttributeQuickFix : QuickFixBase
     {
         private readonly IAttributesUpdater _attributesUpdater;

Rubberduck.CodeAnalysis/QuickFixes/RemoveCommentQuickFix.cs

@@ -5,6 +5,33 @@
 
 namespace Rubberduck.Inspections.QuickFixes
 {
+    /// <summary>
+    /// Removes a comment.
+    /// </summary>
+    /// <inspections>
+    /// <inspection name="ObsoleteCommentSyntaxInspection" />
+    /// </inspections>
+    /// <canfix procedure="true" module="true" project="true" />
+    /// <example>
+    /// <before>
+    /// <![CDATA[
+    /// Option Explicit
+    /// 
+    /// Public Sub DoSomething()
+    ///     Rem does something
+    /// End Sub
+    /// ]]>
+    /// </before>
+    /// <after>
+    /// <![CDATA[
+    /// Option Explicit
+    /// 
+    /// Public Sub DoSomething()
+    ///     
+    /// End Sub
+    /// ]]>
+    /// </after>
+    /// </example>
     public sealed class RemoveCommentQuickFix : QuickFixBase
     {
         public RemoveCommentQuickFix()
@@ -17,7 +44,7 @@ public override void Fix(IInspectionResult result, IRewriteSession rewriteSessio
             rewriter.Remove(result.Context);
         }
 
-        public override string Description(IInspectionResult result) => Resources.Inspections.QuickFixes.RemoveObsoleteStatementQuickFix;
+        public override string Description(IInspectionResult result) => Resources.Inspections.QuickFixes.RemoveCommentQuickFix;
 
         public override bool CanFixInProcedure => true;
         public override bool CanFixInModule => true;

Rubberduck.CodeAnalysis/QuickFixes/RemoveDuplicatedAnnotationQuickFix.cs

@@ -7,6 +7,34 @@
 
 namespace Rubberduck.Inspections.QuickFixes
 {
+    /// <summary>
+    /// Removes a duplicated annotation comment.
+    /// </summary>
+    /// <inspections>
+    /// <inspection name="DuplicatedAnnotationInspection" />
+    /// </inspections>
+    /// <canfix procedure="true" module="true" project="true" />
+    /// <example>
+    /// <before>
+    /// <![CDATA[
+    /// Option Explicit
+    /// 
+    /// '@Obsolete
+    /// '@Obsolete
+    /// Public Sub DoSomething()
+    /// End Sub
+    /// ]]>
+    /// </before>
+    /// <after>
+    /// <![CDATA[
+    /// Option Explicit
+    /// 
+    /// '@Obsolete
+    /// Public Sub DoSomething()
+    /// End Sub
+    /// ]]>
+    /// </after>
+    /// </example>
     public sealed class RemoveDuplicatedAnnotationQuickFix : QuickFixBase
     {
         private readonly IAnnotationUpdater _annotationUpdater;

Rubberduck.CodeAnalysis/QuickFixes/RemoveEmptyElseBlockQuickFix.cs

@@ -6,6 +6,38 @@
 
 namespace Rubberduck.Inspections.QuickFixes
 {
+    /// <summary>
+    /// Removes an empty Else block.
+    /// </summary>
+    /// <inspections>
+    /// <inspection name="EmptyElseBlockInspection" />
+    /// </inspections>
+    /// <canfix procedure="false" module="false" project="false" />
+    /// <example>
+    /// <before>
+    /// <![CDATA[
+    /// Option Explicit
+    /// 
+    /// Public Sub DoSomething()
+    ///     If Application.Calculation = xlCalculationAutomatic Then
+    ///         Application.Calculation = xlCalculationManual
+    ///     Else
+    ///     End If
+    /// End Sub
+    /// ]]>
+    /// </before>
+    /// <after>
+    /// <![CDATA[
+    /// Option Explicit
+    /// 
+    /// Public Sub DoSomething()
+    ///     If Application.Calculation = xlCalculationAutomatic Then
+    ///         Application.Calculation = xlCalculationManual
+    ///     End If
+    /// End Sub
+    /// ]]>
+    /// </after>
+    /// </example>
     public sealed class RemoveEmptyElseBlockQuickFix : QuickFixBase
     {
         public RemoveEmptyElseBlockQuickFix()

Rubberduck.CodeAnalysis/QuickFixes/RemoveEmptyIfBlockQuickFix.cs

@@ -10,6 +10,41 @@
 
 namespace Rubberduck.Inspections.QuickFixes
 {
+    /// <summary>
+    /// Removes an empty conditional block by inverting the condition expression.
+    /// </summary>
+    /// <inspections>
+    /// <inspection name="EmptyIfBlockInspection" />
+    /// </inspections>
+    /// <canfix procedure="false" module="false" project="false" />
+    /// <example>
+    /// <before>
+    /// <![CDATA[
+    /// Option Explicit
+    /// 
+    /// Public Sub DoSomething()
+    ///     If Application.Calculation = xlCalculationManual Then
+    ///     Else
+    ///         Application.Calculation = xlCalculationManual
+    ///     End If
+    ///     '...
+    /// End Sub
+    /// ]]>
+    /// </before>
+    /// <after>
+    /// <![CDATA[
+    /// Option Explicit
+    /// 
+    /// Public Sub DoSomething()
+    ///     If Application.Calculation <> xlCalculationManual Then
+    ///     
+    ///         Application.Calculation = xlCalculationManual
+    ///     End If
+    ///     '...
+    /// End Sub
+    /// ]]>
+    /// </after>
+    /// </example>
     public sealed class RemoveEmptyIfBlockQuickFix : QuickFixBase
     {
         public RemoveEmptyIfBlockQuickFix()

Rubberduck.CodeAnalysis/QuickFixes/RemoveExplicitByRefModifierQuickFix.cs

@@ -8,10 +8,36 @@
 using Rubberduck.Parsing.Rewriter;
 using Rubberduck.Parsing.Symbols;
 using Rubberduck.Parsing.VBA;
-using Rubberduck.Parsing.VBA.Extensions;
 
 namespace Rubberduck.Inspections.QuickFixes
 {
+    /// <summary>
+    /// Removes an explicit ByRef modifier, making it implicit.
+    /// </summary>
+    /// <inspections>
+    /// <inspection name="RedundantByRefModifierInspection" />
+    /// </inspections>
+    /// <canfix procedure="true" module="true" project="true" />
+    /// <example>
+    /// <before>
+    /// <![CDATA[
+    /// Option Explicit
+    /// 
+    /// Public Sub DoSomething(ByRef value As Long)
+    ///     '...
+    /// End Sub
+    /// ]]>
+    /// </before>
+    /// <after>
+    /// <![CDATA[
+    /// Option Explicit
+    /// 
+    /// Public Sub DoSomething(value As Long)
+    ///     '...
+    /// End Sub
+    /// ]]>
+    /// </after>
+    /// </example>
     public sealed class RemoveExplicitByRefModifierQuickFix : QuickFixBase
     {
         private readonly IDeclarationFinderProvider _declarationFinderProvider;

Rubberduck.CodeAnalysis/QuickFixes/RemoveExplicitCallStatementQuickFix.cs

@@ -6,6 +6,41 @@
 
 namespace Rubberduck.Inspections.QuickFixes
 {
+    /// <summary>
+    /// Makes a call statement implicit by removing the 'Call' keyword, adjusting argument list parentheses accordingly.
+    /// </summary>
+    /// <inspections>
+    /// <inspection name="ObsoleteCallStatementInspection" />
+    /// </inspections>
+    /// <canfix procedure="true" module="true" project="true" />
+    /// <example>
+    /// <before>
+    /// <![CDATA[
+    /// Option Explicit
+    /// 
+    /// Public Sub DoSomething()
+    ///     Call DoSomethingElse(42)
+    /// End Sub
+    /// 
+    /// Private Sub DoSomethingElse(ByVal value As Long)
+    ///     Debug.Print value
+    /// End Sub
+    /// ]]>
+    /// </before>
+    /// <after>
+    /// <![CDATA[
+    /// Option Explicit
+    /// 
+    /// Public Sub DoSomething()
+    ///     DoSomethingElse 42
+    /// End Sub
+    /// 
+    /// Private Sub DoSomethingElse(ByVal value As Long)
+    ///     Debug.Print value
+    /// End Sub
+    /// ]]>
+    /// </after>
+    /// </example>
     public sealed class RemoveExplicitCallStatementQuickFix : QuickFixBase
     {
         public RemoveExplicitCallStatementQuickFix()

Rubberduck.CodeAnalysis/QuickFixes/RemoveExplicitLetStatementQuickFix.cs

@@ -7,6 +7,37 @@
 
 namespace Rubberduck.Inspections.QuickFixes
 {
+    /// <summary>
+    /// Makes the 'Let' keyword of a value assignment implicit.
+    /// </summary>
+    /// <inspections>
+    /// <inspection name="ObsoleteLetStatementInspection" />
+    /// </inspections>
+    /// <canfix procedure="true" module="true" project="true" />
+    /// <example>
+    /// <before>
+    /// <![CDATA[
+    /// Option Explicit
+    /// 
+    /// Public Sub DoSomething()
+    ///     Dim value As Long
+    ///     Let value = 42
+    ///     Debug.Print value
+    /// End Sub
+    /// ]]>
+    /// </before>
+    /// <after>
+    /// <![CDATA[
+    /// Option Explicit
+    /// 
+    /// Public Sub DoSomething()
+    ///     Dim value As Long
+    ///     value = 42
+    ///     Debug.Print value
+    /// End Sub
+    /// ]]>
+    /// </after>
+    /// </example>
     public sealed class RemoveExplicitLetStatementQuickFix : QuickFixBase
     {
         public RemoveExplicitLetStatementQuickFix()

Rubberduck.CodeAnalysis/QuickFixes/RemoveLocalErrorQuickFix.cs

@@ -6,6 +6,45 @@
 
 namespace Rubberduck.Inspections.QuickFixes
 {
+    /// <summary>
+    /// Makes the 'Local' keyword of an 'On Error' statement implicit.
+    /// </summary>
+    /// <inspections>
+    /// <inspection name="OnLocalErrorInspection" />
+    /// </inspections>
+    /// <canfix procedure="true" module="true" project="true" />
+    /// <example>
+    /// <before>
+    /// <![CDATA[
+    /// Option Explicit
+    /// 
+    /// Public Sub DoSomething()
+    ///     On Local Error GoTo CleanFail
+    ///     Debug.Print 42 / 0
+    /// CleanExit:
+    ///     Exit Sub
+    /// CleanFail:
+    ///     Debug.Print Err.Description
+    ///     Resume CleanExit
+    /// End Sub
+    /// ]]>
+    /// </before>
+    /// <after>
+    /// <![CDATA[
+    /// Option Explicit
+    /// 
+    /// Public Sub DoSomething()
+    ///     On Error GoTo CleanFail
+    ///     Debug.Print 42 / 0
+    /// CleanExit:
+    ///     Exit Sub
+    /// CleanFail:
+    ///     Debug.Print Err.Description
+    ///     Resume CleanExit
+    /// End Sub
+    /// ]]>
+    /// </after>
+    /// </example>
     public sealed class RemoveLocalErrorQuickFix : QuickFixBase
     {
         public RemoveLocalErrorQuickFix()