Skip to content

Commit bd073dd

Browse files
committed
xmldocs edits; adjusted RequiredLibrary/RequiredHost attributes.
1 parent d7e914e commit bd073dd

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

Rubberduck.CodeAnalysis/Inspections/Concrete/ImplicitActiveSheetReferenceInspection.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@
99
namespace Rubberduck.CodeAnalysis.Inspections.Concrete
1010
{
1111
/// <summary>
12-
/// Locates unqualified Worksheet.Range/Cells/Columns/Rows member calls inside worksheet modules.
12+
/// Locates unqualified Worksheet.Range/Cells/Columns/Rows member calls implicitly referring to ActiveSheet.
1313
/// </summary>
1414
/// <reference name="Excel" />
1515
/// <why>
16-
/// Implicit references to the active worksheet rarely mean to be working with *whatever worksheet is currently active*.
16+
/// Implicit references to the active worksheet (ActiveSheet) rarely mean to be working with *whatever worksheet is currently active*.
1717
/// By explicitly qualifying these member calls with a specific Worksheet object, the assumptions are removed, the code
1818
/// is more robust, and will be less likely to throw run-time error 1004 or produce unexpected results
1919
/// when the active sheet isn't the expected one.

Rubberduck.CodeAnalysis/Inspections/Concrete/ImplicitContainingWorkbookReferenceInspection.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@
1313
namespace Rubberduck.CodeAnalysis.Inspections.Concrete
1414
{
1515
/// <summary>
16-
/// Locates unqualified Workbook.Worksheets/Sheets/Names member calls inside workbook document modules that implicitly refer to the containing workbook.
16+
/// Locates unqualified Workbook.Worksheets/Sheets/Names member calls inside workbook document modules, that implicitly refer to the host workbook.
1717
/// </summary>
18-
/// <reference name="Excel" />
18+
/// <hostApp name="Excel" />
1919
/// <why>
20-
/// Implicit references inside a workbook document module can be mistakes for implicit references to the active workbook, which is the behavior in all other modules
21-
/// By explicitly qualifying these member calls with Me, the ambiguity can be resolved.
20+
/// Implicit references inside a workbook document module can easily be mistaken for implicit references to the active workbook (ActiveWorkbook), which is the behavior in all other module types.
21+
/// By explicitly qualifying these member calls with 'Me', the ambiguity can be resolved. If the intent is to actually refer to the active workbook, qualify with 'ActiveWorkbook' to prevent a bug.
2222
/// </why>
2323
/// <example hasResult="true">
2424
/// <module name="ThisWorkbook" type="Document Module">
@@ -40,7 +40,7 @@ namespace Rubberduck.CodeAnalysis.Inspections.Concrete
4040
/// ]]>
4141
/// </module>
4242
/// </example>
43-
[RequiredLibrary("Excel")]
43+
[RequiredHost("Excel")]
4444
internal sealed class ImplicitContainingWorkbookReferenceInspection : ImplicitWorkbookReferenceInspectionBase
4545
{
4646
public ImplicitContainingWorkbookReferenceInspection(IDeclarationFinderProvider declarationFinderProvider)

Rubberduck.CodeAnalysis/Inspections/Concrete/ImplicitContainingWorksheetReferenceInspection.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@
1010
namespace Rubberduck.CodeAnalysis.Inspections.Concrete
1111
{
1212
/// <summary>
13-
/// Locates unqualified Worksheet.Range/Cells/Columns/Rows member calls inside worksheet modules that implicitly refer to the containing sheet.
13+
/// Locates unqualified Worksheet.Range/Cells/Columns/Rows member calls inside worksheet modules, that implicitly refer to the containing sheet component.
1414
/// </summary>
15-
/// <reference name="Excel" />
15+
/// <hostApp name="Excel" />
1616
/// <why>
17-
/// Implicit references inside a worksheet document module can be mistakes for implicit references to the active worksheet, which is the behavior in all other places.
18-
/// By explicitly qualifying these member calls with Me, the ambiguity can be resolved.
17+
/// Implicit references inside a worksheet document module can easily be mistaken for implicit references to the active worksheet (ActiveSheet), which is the behavior in all other module types.
18+
/// By explicitly qualifying these member calls with 'Me', the ambiguity can be resolved. If the intent is to refer to the active worksheet, qualify with 'ActiveSheet' to prevent a bug.
1919
/// </why>
2020
/// <example hasResult="true">
2121
/// <module name="Sheet1" type="Document Module">
@@ -37,7 +37,7 @@ namespace Rubberduck.CodeAnalysis.Inspections.Concrete
3737
/// ]]>
3838
/// </module>
3939
/// </example>
40-
[RequiredLibrary("Excel")]
40+
[RequiredHost("Excel")]
4141
internal sealed class ImplicitContainingWorksheetReferenceInspection : ImplicitSheetReferenceInspectionBase
4242
{
4343
public ImplicitContainingWorksheetReferenceInspection(IDeclarationFinderProvider declarationFinderProvider)

0 commit comments

Comments
 (0)