Skip to content

Commit 4b2f10c

Browse files
authored
Merge pull request #6046 from rubberduck-vba/xmldoc-fixes
Some xmldoc fixes
2 parents 9716496 + e7508d1 commit 4b2f10c

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

Rubberduck.CodeAnalysis/Inspections/Concrete/MultipleDeclarationsInspection.cs

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,32 @@
99
namespace Rubberduck.CodeAnalysis.Inspections.Concrete
1010
{
1111
/// <summary>
12-
/// Flags declaration statements spanning multiple physical lines of code.
12+
/// Flags declaration statements declaring multiple variables.
1313
/// </summary>
1414
/// <why>
15-
/// Declaration statements should generally declare a single variable.
15+
/// Declaration statements should generally declare a single variable.
16+
/// Although this inspection does not take variable types into account, it is a common mistake to only declare an explicit type on the last variable in a list.
1617
/// </why>
1718
/// <example hasResult="true">
1819
/// <module name="MyModule" type="Standard Module">
1920
/// <![CDATA[
20-
/// Dim foo As Long, bar As Long
21+
/// 'note: RowNumber is untyped / implicitly Variant
22+
/// Dim RowNumber, ColumnNumber As Long
2123
/// ]]>
2224
/// </module>
2325
/// </example>
2426
/// <example hasResult="true">
2527
/// <module name="MyModule" type="Standard Module">
2628
/// <![CDATA[
27-
/// Dim foo , bar As Long
29+
/// Dim RowNumber As Long, ColumnNumber As Long
2830
/// ]]>
2931
/// </module>
3032
/// </example>
3133
/// <example hasResult="false">
3234
/// <module name="MyModule" type="Standard Module">
3335
/// <![CDATA[
34-
/// Dim foo As Long
35-
/// Dim bar As Long
36+
/// Dim RowNumber As Long
37+
/// Dim ColumnNumber As Long
3638
/// ]]>
3739
/// </module>
3840
/// </example>

Rubberduck.CodeAnalysis/QuickFixes/Concrete/ConvertToProcedureQuickFix.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ namespace Rubberduck.CodeAnalysis.QuickFixes.Concrete
1717
/// </summary>
1818
/// <inspections>
1919
/// <inspection name="NonReturningFunctionInspection" />
20-
/// <inspection name="FunctionReturnValueNotUsedInspection" />
20+
/// <inspection name="FunctionReturnValueAlwaysDiscardedInspection" />
2121
/// </inspections>
2222
/// <canfix multiple="true" procedure="false" module="true" project="false" all="false" />
2323
/// <example>

0 commit comments

Comments
 (0)