Skip to content

Commit 735e02a

Browse files
committed
reworded summary
1 parent 409f5c0 commit 735e02a

File tree

5 files changed

+23
-13
lines changed

5 files changed

+23
-13
lines changed

Rubberduck.Parsing/Annotations/Concrete/DescriptionAnnotation.cs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
namespace Rubberduck.Parsing.Annotations.Concrete
77
{
88
/// <summary>
9-
/// @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.
9+
/// @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.
1010
/// </summary>
1111
/// <parameter name="DocString" type="Text">
1212
/// 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
1515
/// This documentation string appears in the VBE's own Object Browser, as well as in various Rubberduck UI elements.
1616
/// </remarks>
1717
/// <example>
18-
/// <module name="Class1" type="Class Module">
1918
/// <before>
19+
/// <module name="Class1" type="Class Module">
2020
/// <![CDATA[
2121
/// Option Explicit
2222
///
2323
/// @Description("Does something")
2424
/// Public Sub DoSomething()
2525
/// End Sub
2626
/// ]]>
27+
/// </module>
2728
/// </before>
2829
/// <after>
30+
/// <module name="Class1" type="Class Module">
2931
/// <![CDATA[
3032
/// Option Explicit
3133
///
@@ -34,8 +36,8 @@ namespace Rubberduck.Parsing.Annotations.Concrete
3436
/// Attribute DoSomething.VB_Description = "Does something"
3537
/// End Sub
3638
/// ]]>
37-
/// </after>
3839
/// </module>
40+
/// </after>
3941
/// </example>
4042
public sealed class DescriptionAnnotation : DescriptionAttributeAnnotationBase
4143
{

Rubberduck.Parsing/Annotations/Concrete/MemberAttributeAnnotation.cs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
namespace Rubberduck.Parsing.Annotations.Concrete
77
{
88
/// <summary>
9-
/// @MemberAttribute annotation, allows specifying arbitrary VB_Attribute for members. Use the quick-fixes to "Rubberduck Opportunities" code inspections to synchronize annotations and attributes.
9+
/// @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.
1010
/// </summary>
1111
/// <parameter name="VB_Attribute" type="Identifier">
1212
/// The literal identifier name of the member VB_Attribute.
@@ -19,17 +19,19 @@ namespace Rubberduck.Parsing.Annotations.Concrete
1919
/// This annotation may be used with module variable targets.
2020
/// </remarks>
2121
/// <example>
22-
/// <module name="Class1" type="Class Module">
2322
/// <before>
23+
/// <module name="Class1" type="Class Module">
2424
/// <![CDATA[
2525
/// Option Explicit
2626
///
2727
/// '@MemberAttribute VB_Description, "Does something"
2828
/// Public Sub DoSomething()
2929
/// End Sub
3030
/// ]]>
31+
/// </module>
3132
/// </before>
3233
/// <after>
34+
/// <module name="Class1" type="Class Module">
3335
/// <![CDATA[
3436
/// Option Explicit
3537
///
@@ -38,8 +40,8 @@ namespace Rubberduck.Parsing.Annotations.Concrete
3840
/// Attribute DoSomething.VB_Description = "Does something"
3941
/// End Sub
4042
/// ]]>
41-
/// </after>
4243
/// </module>
44+
/// </after>
4345
/// </example>
4446
public class MemberAttributeAnnotation : FlexibleAttributeAnnotationBase
4547
{

Rubberduck.Parsing/Annotations/Concrete/ModuleAttributeAnnotation.cs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
namespace Rubberduck.Parsing.Annotations.Concrete
77
{
88
/// <summary>
9-
/// @ModuleAttribute annotation, allows specifying arbitrary VB_Attribute for modules. Use the quick-fixes to "Rubberduck Opportunities" code inspections to synchronize annotations and attributes.
9+
/// @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.
1010
/// </summary>
1111
/// <parameter name="VB_Attribute" type="Identifier">
1212
/// The literal identifier name of the member VB_Attribute.
@@ -15,17 +15,19 @@ namespace Rubberduck.Parsing.Annotations.Concrete
1515
/// The comma-separated attribute values, as applicable.
1616
/// </parameter>
1717
/// <example>
18-
/// <module name="Class1" type="Class Module">
1918
/// <before>
19+
/// <module name="Class1" type="Class Module">
2020
/// <![CDATA[
2121
/// '@ModuleAttribute VB_Ext_Key, "Key", "Value"
2222
/// Option Explicit
2323
///
2424
/// Public Sub DoSomething()
2525
/// End Sub
2626
/// ]]>
27+
/// </module>
2728
/// </before>
2829
/// <after>
30+
/// <module name="Class1" type="Class Module">
2931
/// <![CDATA[
3032
/// Attribute VB_Ext_KEY = "Key", "Value"
3133
/// '@ModuleAttribute VB_Ext_Key, "Key", "Value"
@@ -34,8 +36,8 @@ namespace Rubberduck.Parsing.Annotations.Concrete
3436
/// Public Sub DoSomething()
3537
/// End Sub
3638
/// ]]>
37-
/// </after>
3839
/// </module>
40+
/// </after>
3941
/// </example>
4042
public class ModuleAttributeAnnotation : FlexibleAttributeAnnotationBase
4143
{

Rubberduck.Parsing/Annotations/Concrete/ModuleDescriptionAnnotation.cs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,19 @@ namespace Rubberduck.Parsing.Annotations.Concrete
1616
/// This documentation string appears in the VBE's own Object Browser, as well as in various Rubberduck UI elements.
1717
/// </remarks>
1818
/// <example>
19-
/// <module name="Class1" type="Class Module">
2019
/// <before>
20+
/// <module name="Class1" type="Class Module">
2121
/// <![CDATA[
2222
/// '@ModuleDescription("Represents an object responsible for doing something.")
2323
/// Option Explicit
2424
///
2525
/// Public Sub DoSomething()
2626
/// End Sub
2727
/// ]]>
28+
/// </module>
2829
/// </before>
2930
/// <after>
31+
/// <module name="Class1" type="Class Module">
3032
/// <![CDATA[
3133
/// Attribute VB_Description = "Represents an object responsible for doing something."
3234
/// '@ModuleDescription("Represents an object responsible for doing something.")
@@ -35,8 +37,8 @@ namespace Rubberduck.Parsing.Annotations.Concrete
3537
/// Public Sub DoSomething()
3638
/// End Sub
3739
/// ]]>
38-
/// </after>
3940
/// </module>
41+
/// </after>
4042
/// </example>
4143
public sealed class ModuleDescriptionAnnotation : DescriptionAttributeAnnotationBase
4244
{

Rubberduck.Parsing/Annotations/Concrete/VariableDescriptionAnnotation.cs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ namespace Rubberduck.Parsing.Annotations.Concrete
1515
/// 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.
1616
/// </remarks>
1717
/// <example>
18-
/// <module name="Class1" type="Class Module">
1918
/// <before>
19+
/// <module name="Class1" type="Class Module">
2020
/// <![CDATA[
2121
/// Option Explicit
2222
///
@@ -26,8 +26,10 @@ namespace Rubberduck.Parsing.Annotations.Concrete
2626
/// Public Sub DoSomething()
2727
/// End Sub
2828
/// ]]>
29+
/// </module>
2930
/// </before>
3031
/// <after>
32+
/// <module name="Class1" type="Class Module">
3133
/// <![CDATA[
3234
/// Option Explicit
3335
///
@@ -38,8 +40,8 @@ namespace Rubberduck.Parsing.Annotations.Concrete
3840
/// Public Sub DoSomething()
3941
/// End Sub
4042
/// ]]>
41-
/// </after>
4243
/// </module>
44+
/// </after>
4345
/// </example>
4446
public class VariableDescriptionAnnotation : DescriptionAttributeAnnotationBase
4547
{

0 commit comments

Comments
 (0)