Skip to content

Commit 5bcd674

Browse files
authored
clarified example
1 parent 95ac82a commit 5bcd674

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

Rubberduck.CodeAnalysis/Inspections/Concrete/ImplementedInterfaceMemberInspection.cs

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,28 @@
1111
namespace Rubberduck.Inspections.Concrete
1212
{
1313
/// <summary>
14-
/// Identifies implemented members of class modules that are used as interfaces.
14+
/// Identifies members of class modules that are used as interfaces, but that have a concrete implementation.
1515
/// </summary>
1616
/// <why>
17-
/// Interfaces provide a unified programmatic access to different objects, and therefore are rarely instantiated as concrete objects.
17+
/// Interfaces provide an abstract, unified programmatic access to different objects; concrete implementations of their members should be in a separate module that 'Implements' the interface.
1818
/// </why>
1919
/// <example hasResults="false">
2020
/// <![CDATA[
21-
/// Sub Foo()
22-
/// ' ...
21+
/// Option Explicit
22+
/// '@Interface
23+
///
24+
/// Public Sub DoSomething()
25+
/// ' empty interface stub
2326
/// End Sub
2427
/// ]]>
2528
/// </example>
2629
/// <example hasResults="true">
2730
/// <![CDATA[
28-
/// Sub Foo()
29-
/// MsgBox "?"
31+
/// Option Explicit
32+
/// '@Interface
33+
///
34+
/// Public Sub DoSomething()
35+
/// MsgBox "Hello from interface!"
3036
/// End Sub
3137
/// ]]>
3238
/// </example>
@@ -51,4 +57,4 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
5157
result));
5258
}
5359
}
54-
}
60+
}

0 commit comments

Comments
 (0)