Improve meta for default member inspections

Author: MDoerner

Rubberduck.CodeAnalysis/Inspections/Concrete/ImplicitDefaultMemberAccessInspection.cs

@@ -8,7 +8,7 @@
 namespace Rubberduck.Inspections.Concrete
 {
     /// <summary>
-    /// Identifies the use non-indexed default member accesses.
+    /// Identifies the use of non-indexed default member accesses.
     /// </summary>
     /// <why>
     /// Default member accesses hide away the actually called member. This is especially misleading if there is no indication in the expression that such a call is made
@@ -24,16 +24,8 @@ namespace Rubberduck.Inspections.Concrete
     /// </example>
     /// <example hasResult="true">
     /// <![CDATA[
-    /// Class1:
-    ///
-    /// Public Property Let Foo(RHS As Long)
-    /// Attibute Foo.VB_UserMemId = 0
-    /// End Function
-    ///
-    /// Module:
-    /// 
-    /// Public Sub DoSomething(ByVal arg As Class1)
-    ///     Dim bar As Variant
+    /// Public Sub DoSomething(ByVal arg As ADODB.Connection)
+    ///     Dim bar As String
     ///     arg = bar
     /// End Sub
     /// ]]>
@@ -48,17 +40,9 @@ namespace Rubberduck.Inspections.Concrete
     /// </example>
     /// <example hasResult="false">
     /// <![CDATA[
-    /// Class1:
-    ///
-    /// Public Property Let Foo(RHS As Long)
-    /// Attibute Foo.VB_UserMemId = 0
-    /// End Function
-    ///
-    /// Module:
-    /// 
-    /// Public Sub DoSomething(ByVal arg As Class1)
-    ///     Dim bar As Variant
-    ///     arg.Foo = bar
+    /// Public Sub DoSomething(ByVal arg As ADODB.Connection)
+    ///     Dim bar As String
+    ///     arg.ConnectionString = bar
     /// End Sub
     /// ]]>
     public sealed class ImplicitDefaultMemberAccessInspection : IdentifierReferenceInspectionBase

Rubberduck.CodeAnalysis/Inspections/Concrete/ImplicitRecursiveDefaultMemberAccessInspection.cs

@@ -8,59 +8,63 @@
 namespace Rubberduck.Inspections.Concrete
 {
     /// <summary>
-    /// Identifies the use indexed default member accesses that require a recursive default member resolution.
+    /// Identifies the use of indexed default member accesses that require a recursive default member resolution.
     /// </summary>
     /// <why>
     /// Default member accesses hide away the actually called member. This is especially misleading if there is no indication in the expression that such a call is made
     /// and the final default member is not on the interface of the object itself. In particular, this can cause errors in which a member was forgotten to be called to go unnoticed.
     /// </why>
     /// <example hasResult="true">
+    /// <module name="Class1" type="Class Module">
     /// <![CDATA[
-    /// Class1:
-    ///
     /// Public Function Foo() As Class2
     /// Attibute Foo.VB_UserMemId = 0
     ///     Set Foo = New Class2
     /// End Function
-    /// 
-    /// Class2:
-    ///
+    /// ]]>
+    /// </module>
+    /// <module name="Class2" type="Class Module">
+    /// <![CDATA[
     /// Public Function Bar() As Long
     /// Attibute Bar.VB_UserMemId = 0
     ///     Foo = 42
     /// End Function
-    ///
-    /// Module:
-    /// 
+    /// ]]>
+    /// </module>
+    /// <module name="Module" type="Standard Module">
+    /// <![CDATA[
     /// Public Sub DoSomething(ByVal arg As Class1)
     ///     Dim bar As Variant
     ///     bar = arg
     /// End Sub
     /// ]]>
+    /// </module>
     /// </example>
     /// <example hasResult="false">
+    /// <module name="Class1" type="Class Module">
     /// <![CDATA[
-    /// Class1:
-    ///
     /// Public Function Foo() As Class2
     /// Attibute Foo.VB_UserMemId = 0
     ///     Set Foo = New Class2
     /// End Function
-    /// 
-    /// Class2:
-    ///
+    /// ]]>
+    /// </module>
+    /// <module name="Class2" type="Class Module">
+    /// <![CDATA[
     /// Public Function Bar() As Long
     /// Attibute Bar.VB_UserMemId = 0
     ///     Foo = 42
     /// End Function
-    ///
-    /// Module:
-    /// 
+    /// ]]>
+    /// </module>
+    /// <module name="Module" type="Standard Module">
+    /// <![CDATA[
     /// Public Sub DoSomething(ByVal arg As Class1)
     ///     Dim bar As Variant
     ///     bar = arg.Foo().Bar()
     /// End Sub
     /// ]]>
+    /// </module>
     /// </example>
     public sealed class ImplicitRecursiveDefaultMemberAccessInspection : IdentifierReferenceInspectionBase
     {

Rubberduck.CodeAnalysis/Inspections/Concrete/ImplicitUnboundDefaultMemberAccessInspection.cs

@@ -10,7 +10,7 @@
 namespace Rubberduck.Inspections.Concrete
 {
     /// <summary>
-    /// Identifies the use indexed default member accesses for which the default member cannot be determined at compile time.
+    /// Identifies the use of indexed default member accesses for which the default member cannot be determined at compile time.
     /// </summary>
     /// <why>
     /// Default member accesses hide away the actually called member. This is especially misleading if there is no indication in the expression that such a call is made

Rubberduck.CodeAnalysis/Inspections/Concrete/IndexedDefaultMemberAccessInspection.cs

@@ -9,42 +9,24 @@
 namespace Rubberduck.Inspections.Concrete
 {
     /// <summary>
-    /// Identifies the use indexed default member accesses.
+    /// Identifies the use of indexed default member accesses.
     /// </summary>
     /// <why>
     /// An indexed default member access hides away the actually called member.
     /// </why>
     /// <example hasResult="true">
     /// <![CDATA[
-    /// Class1:
-    ///
-    /// Public Function Foo(ByVal arg As Long) As Long
-    /// Attibute Foo.VB_UserMemId = 0
-    ///     Foo = 42
-    /// End Function
-    ///
-    /// Module:
-    /// 
-    /// Public Sub DoSomething(ByVal arg As Class1)
+    /// Public Sub DoSomething(ByVal coll As Collection)
     ///     Dim bar As Variant
-    ///     bar = arg(23)
+    ///     bar = coll(23)
     /// End Sub
     /// ]]>
     /// </example>
     /// <example hasResult="false">
     /// <![CDATA[
-    /// Class1:
-    ///
-    /// Public Function Foo(ByVal arg As Long) As Long
-    /// Attibute Foo.VB_UserMemId = 0
-    ///     Foo = 42
-    /// End Function
-    ///
-    /// Module:
-    /// 
-    /// Public Sub DoSomething(ByVal arg As Class1)
+    /// Public Sub DoSomething(ByVal coll As Collection)
     ///     Dim bar As Variant
-    ///     bar = arg.Foo(23)
+    ///     bar = coll.Item(23)
     /// End Sub
     /// ]]>
     /// </example>

Rubberduck.CodeAnalysis/Inspections/Concrete/IndexedRecursiveDefaultMemberAccessInspection.cs

@@ -9,7 +9,7 @@
 namespace Rubberduck.Inspections.Concrete
 {
     /// <summary>
-    /// Identifies the use indexed default member accesses that require a recursive default member resolution.
+    /// Identifies the use of indexed default member accesses that require a recursive default member resolution.
     /// </summary>
     /// <why>
     /// An indexed default member access hides away the actually called member. This is especially problematic if the corresponding parameterized default member is not on the interface of the object itself.

Rubberduck.CodeAnalysis/Inspections/Concrete/IndexedUnboundDefaultMemberAccessInspection.cs

@@ -11,7 +11,7 @@
 namespace Rubberduck.Inspections.Concrete
 {
     /// <summary>
-    /// Identifies the use indexed default member accesses for which the default member cannot be determined at compile time.
+    /// Identifies the use of indexed default member accesses for which the default member cannot be determined at compile time.
     /// </summary>
     /// <why>
     /// An indexed default member access hides away the actually called member. This is especially problematic if the default member cannot be determined from the declared type of the object.