reworded summary

rubberduck-vba · Jul 25, 2020 · 735e02a · 735e02a
1 parent 409f5c0
commit 735e02a
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 13 deletions.
diff --git a/Rubberduck.Parsing/Annotations/Concrete/DescriptionAnnotation.cs b/Rubberduck.Parsing/Annotations/Concrete/DescriptionAnnotation.cs
@@ -6,7 +6,7 @@
 namespace Rubberduck.Parsing.Annotations.Concrete
 {
     /// <summary>
-    /// @Description annotation, uses the VB_Description member attribute to provide a docstring for a module member. Use the quick-fixes to "Rubberduck Opportunities" code inspections to synchronize annotations and attributes.
+    /// @Description annotation, indicates that the member should have a VB_Description attribute to provide a docstring. Use the quick-fixes to "Rubberduck Opportunities" code inspections to synchronize annotations and attributes.
     /// </summary>
     /// <parameter name="DocString" type="Text">
     /// This string literal parameter does not support expressions and/or multiline inputs. The string literal is used as-is as the value of the hidden member attribute.
@@ -15,17 +15,19 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     /// This documentation string appears in the VBE's own Object Browser, as well as in various Rubberduck UI elements.
     /// </remarks>
     /// <example>
-    /// <module name="Class1" type="Class Module">
     /// <before>
+    /// <module name="Class1" type="Class Module">
     /// <![CDATA[
     /// Option Explicit
     ///
     /// @Description("Does something")
     /// Public Sub DoSomething()
     /// End Sub
     /// ]]>
+    /// </module>
     /// </before>
     /// <after>
+    /// <module name="Class1" type="Class Module">
     /// <![CDATA[
     /// Option Explicit
     ///
@@ -34,8 +36,8 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     /// Attribute DoSomething.VB_Description = "Does something"
     /// End Sub
     /// ]]>
-    /// </after>
     /// </module>
+    /// </after>
     /// </example>
     public sealed class DescriptionAnnotation : DescriptionAttributeAnnotationBase
     {

diff --git a/Rubberduck.Parsing/Annotations/Concrete/MemberAttributeAnnotation.cs b/Rubberduck.Parsing/Annotations/Concrete/MemberAttributeAnnotation.cs
@@ -6,7 +6,7 @@
 namespace Rubberduck.Parsing.Annotations.Concrete
 {
     /// <summary>
-    /// @MemberAttribute annotation, allows specifying arbitrary VB_Attribute for members. Use the quick-fixes to "Rubberduck Opportunities" code inspections to synchronize annotations and attributes.
+    /// @MemberAttribute annotation, indicates the presence of a hidden member attribute; allows specifying arbitrary VB_Attribute for members. Use the quick-fixes to "Rubberduck Opportunities" code inspections to synchronize annotations and attributes.
     /// </summary>
     /// <parameter name="VB_Attribute" type="Identifier">
     /// The literal identifier name of the member VB_Attribute.
@@ -19,17 +19,19 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     /// This annotation may be used with module variable targets.
     /// </remarks>
     /// <example>
-    /// <module name="Class1" type="Class Module">
     /// <before>
+    /// <module name="Class1" type="Class Module">
     /// <![CDATA[
     /// Option Explicit
     ///
     /// '@MemberAttribute VB_Description, "Does something"
     /// Public Sub DoSomething()
     /// End Sub
     /// ]]>
+    /// </module>
     /// </before>
     /// <after>
+    /// <module name="Class1" type="Class Module">
     /// <![CDATA[
     /// Option Explicit
     ///
@@ -38,8 +40,8 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     /// Attribute DoSomething.VB_Description = "Does something"
     /// End Sub
     /// ]]>
-    /// </after>
     /// </module>
+    /// </after>
     /// </example>
     public class MemberAttributeAnnotation : FlexibleAttributeAnnotationBase
     {

diff --git a/Rubberduck.Parsing/Annotations/Concrete/ModuleAttributeAnnotation.cs b/Rubberduck.Parsing/Annotations/Concrete/ModuleAttributeAnnotation.cs
@@ -6,7 +6,7 @@
 namespace Rubberduck.Parsing.Annotations.Concrete
 {
     /// <summary>
-    /// @ModuleAttribute annotation, allows specifying arbitrary VB_Attribute for modules. Use the quick-fixes to "Rubberduck Opportunities" code inspections to synchronize annotations and attributes.
+    /// @ModuleAttribute annotation, indicates the presence of a hidden module-level attribute; allows specifying arbitrary VB_Attribute for modules. Use the quick-fixes to "Rubberduck Opportunities" code inspections to synchronize annotations and attributes.
     /// </summary>
     /// <parameter name="VB_Attribute" type="Identifier">
     /// The literal identifier name of the member VB_Attribute.
@@ -15,17 +15,19 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     /// The comma-separated attribute values, as applicable.
     /// </parameter>
     /// <example>
-    /// <module name="Class1" type="Class Module">
     /// <before>
+    /// <module name="Class1" type="Class Module">
     /// <![CDATA[
     /// '@ModuleAttribute VB_Ext_Key, "Key", "Value"
     /// Option Explicit
     ///
     /// Public Sub DoSomething()
     /// End Sub
     /// ]]>
+    /// </module>
     /// </before>
     /// <after>
+    /// <module name="Class1" type="Class Module">
     /// <![CDATA[
     /// Attribute VB_Ext_KEY = "Key", "Value"
     /// '@ModuleAttribute VB_Ext_Key, "Key", "Value"
@@ -34,8 +36,8 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     /// Public Sub DoSomething()
     /// End Sub
     /// ]]>
-    /// </after>
     /// </module>
+    /// </after>
     /// </example>
     public class ModuleAttributeAnnotation : FlexibleAttributeAnnotationBase
     {

diff --git a/Rubberduck.Parsing/Annotations/Concrete/ModuleDescriptionAnnotation.cs b/Rubberduck.Parsing/Annotations/Concrete/ModuleDescriptionAnnotation.cs
@@ -16,17 +16,19 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     /// This documentation string appears in the VBE's own Object Browser, as well as in various Rubberduck UI elements.
     /// </remarks>
     /// <example>
-    /// <module name="Class1" type="Class Module">
     /// <before>
+    /// <module name="Class1" type="Class Module">
     /// <![CDATA[
     /// '@ModuleDescription("Represents an object responsible for doing something.")
     /// Option Explicit
     ///
     /// Public Sub DoSomething()
     /// End Sub
     /// ]]>
+    /// </module>
     /// </before>
     /// <after>
+    /// <module name="Class1" type="Class Module">
     /// <![CDATA[
     /// Attribute VB_Description = "Represents an object responsible for doing something."
     /// '@ModuleDescription("Represents an object responsible for doing something.")
@@ -35,8 +37,8 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     /// Public Sub DoSomething()
     /// End Sub
     /// ]]>
-    /// </after>
     /// </module>
+    /// </after>
     /// </example>
     public sealed class ModuleDescriptionAnnotation : DescriptionAttributeAnnotationBase
     {

diff --git a/Rubberduck.Parsing/Annotations/Concrete/VariableDescriptionAnnotation.cs b/Rubberduck.Parsing/Annotations/Concrete/VariableDescriptionAnnotation.cs
@@ -15,8 +15,8 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     /// The @VariableDescription annotation complements the @description annotation, which can be applied to methods. Having separate annotations for variables and members disambiguates any potential scoping issues presenting themselves when the same name is used for both scopes.
     /// </remarks>
     /// <example>
-    /// <module name="Class1" type="Class Module">
     /// <before>
+    /// <module name="Class1" type="Class Module">
     /// <![CDATA[
     /// Option Explicit
     /// 
@@ -26,8 +26,10 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     /// Public Sub DoSomething()
     /// End Sub
     /// ]]>
+    /// </module>
     /// </before>
     /// <after>
+    /// <module name="Class1" type="Class Module">
     /// <![CDATA[
     /// Option Explicit
     /// 
@@ -38,8 +40,8 @@ namespace Rubberduck.Parsing.Annotations.Concrete
     /// Public Sub DoSomething()
     /// End Sub
     /// ]]>
-    /// </after>
     /// </module>
+    /// </after>
     /// </example>
     public class VariableDescriptionAnnotation : DescriptionAttributeAnnotationBase
     {