made <module> a child of <before> and <after> tags for annotations; a…

…llows having new module type in the <after> example.
rubberduck-vba · Jul 25, 2020 · c1c1b91 · c1c1b91
1 parent 735e02a
commit c1c1b91
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 9 deletions.
diff --git a/Rubberduck.Parsing/Annotations/Concrete/DefaultMemberAnnotation.cs b/Rubberduck.Parsing/Annotations/Concrete/DefaultMemberAnnotation.cs
@@ -7,8 +7,8 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     /// @DefaultMember annotation, indicates that the member should have a VB_UserMemId attribute value (0) making it the default member of that class. Use the quick-fixes to "Rubberduck Opportunities" code inspections to synchronize annotations and attributes.
     /// </summary>
     /// <example>
-    /// <module name="Class1" type="Class Module">
     /// <before>
+    /// <module name="Class1" type="Class Module">
     /// <![CDATA[
     /// Option Explicit
     /// Private InternalState As VBA.Collection
@@ -27,8 +27,10 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     ///     Set InternalState = New VBA.Collection
     /// End Sub
     /// ]]>
+    /// </module>
     /// </before>
     /// <after>
+    /// <module name="Class1" type="Class Module">
     /// <![CDATA[
     /// Option Explicit
     /// Private InternalState As VBA.Collection
@@ -48,8 +50,8 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     ///     Set InternalState = New VBA.Collection
     /// End Sub
     /// ]]>
-    /// </after>
     /// </module>
+    /// </after>
     /// </example>
     public sealed class DefaultMemberAnnotation : FixedAttributeValueAnnotationBase
     {

diff --git a/Rubberduck.Parsing/Annotations/Concrete/ExcelHotKeyAnnotation.cs b/Rubberduck.Parsing/Annotations/Concrete/ExcelHotKeyAnnotation.cs
@@ -14,8 +14,8 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     /// A single-letter string argument maps the hotkey. If the letter is in UPPER CASE, the hotkey is Ctrl+Shift+letter; if the letter is lower case, the hotkey is Ctrl+letter. Avoid remapping commonly used keyboard shortcuts!
     /// </parameter>
     /// <example>
-    /// <module name="Module1" type="Standard Module">
     /// <before>
+    /// <module name="Module1" type="Standard Module">
     /// <![CDATA[
     /// Option Explicit
     ///
@@ -24,8 +24,10 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     ///     '...
     /// End Sub
     /// ]]>
+    /// </module>
     /// </before>
     /// <after>
+    /// <module name="Module1" type="Standard Module">
     /// <![CDATA[
     /// Option Explicit
     ///
@@ -35,8 +37,8 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     ///     '...
     /// End Sub
     /// ]]>
-    /// </after>
     /// </module>
+    /// </after>
     /// </example>
     public sealed class ExcelHotKeyAnnotation : FlexibleAttributeValueAnnotationBase
     {

diff --git a/Rubberduck.Parsing/Annotations/Concrete/ExposedModuleAnnotation.cs b/Rubberduck.Parsing/Annotations/Concrete/ExposedModuleAnnotation.cs
@@ -9,17 +9,19 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     /// @Exposed annotation, indicates the presence of a VB_Exposed module attribute value (True) to make a class visible to a referencing project (classes are otherwise private by default). Use the quick-fixes to "Rubberduck Opportunities" code inspections to synchronize annotations and attributes.
     /// </summary>
     /// <example>
-    /// <module name="Class1" type="Class Module">
     /// <before>
+    /// <module name="Class1" type="Class Module">
     /// <![CDATA[
     /// '@Exposed
     /// Option Explicit
     ///
     /// Public Sub DoSomething()
     /// End Sub
     /// ]]>
+    /// </module>
     /// </before>
     /// <after>
+    /// <module name="Class1" type="Class Module">
     /// <![CDATA[
     /// Attribute VB_Exposed = True
     /// '@Exposed
@@ -28,8 +30,8 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     /// Public Sub DoSomething()
     /// End Sub
     /// ]]>
-    /// </after>
     /// </module>
+    /// </after>
     /// </example>
     public sealed class ExposedModuleAnnotation : FixedAttributeValueAnnotationBase
     {

diff --git a/Rubberduck.Parsing/Annotations/Concrete/InterfaceAnnotation.cs b/Rubberduck.Parsing/Annotations/Concrete/InterfaceAnnotation.cs
@@ -9,7 +9,8 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     /// Code Explorer uses an "interface" icon to represent class modules with this annotation.
     /// </remarks>
     /// <example>
-    /// <module name="Tests" type="Standard Module">
+    /// <before>
+    /// <module name="Something" type="Class Module">
     /// <![CDATA[
     /// '@Interface
     /// Option Explicit
@@ -18,6 +19,18 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     /// End Sub
     /// ]]>
     /// </module>
+    /// </before>
+    /// <after>
+    /// <module name="Something" type="Interface Module">
+    /// <![CDATA[
+    /// '@Interface
+    /// Option Explicit
+    ///
+    /// Public Sub DoSomething()
+    /// End Sub
+    /// ]]>
+    /// </module>
+    /// </after>
     /// </example>
     public sealed class InterfaceAnnotation : AnnotationBase
     {

diff --git a/Rubberduck.Parsing/Annotations/Concrete/PredeclaredIdAnnotation.cs b/Rubberduck.Parsing/Annotations/Concrete/PredeclaredIdAnnotation.cs
@@ -7,8 +7,8 @@ namespace Rubberduck.Parsing.Annotations
     /// Consider keeping the default/predeclared instance stateless.
     /// </remarks>
     /// <example>
-    /// <module name="Class1" type="Class Module">
     /// <before>
+    /// <module name="Class1" type="Class Module">
     /// <![CDATA[
     /// '@PredeclaredId
     /// Option Explicit
@@ -17,8 +17,10 @@ namespace Rubberduck.Parsing.Annotations
     ///     Set Create = New Class1
     /// End Sub
     /// ]]>
+    /// </module>
     /// </before>
     /// <after>
+    /// <module name="Class1" type="Predeclared Class">
     /// <![CDATA[
     /// Attribute VB_PredeclaredId = True
     /// '@PredeclaredId
@@ -28,8 +30,8 @@ namespace Rubberduck.Parsing.Annotations
     ///     Set Create = New Class1
     /// End Sub
     /// ]]>
-    /// </after>
     /// </module>
+    /// </after>
     /// </example>
     public sealed class PredeclaredIdAnnotation : FixedAttributeValueAnnotationBase
     {