diff --git a/src/Vogen.Pack.csproj b/src/Vogen.Pack.csproj index c099068846..7ae9d778be 100644 --- a/src/Vogen.Pack.csproj +++ b/src/Vogen.Pack.csproj @@ -52,6 +52,7 @@ + \ No newline at end of file diff --git a/src/Vogen.SharedTypes/ValueObjectAttribute.cs b/src/Vogen.SharedTypes/ValueObjectAttribute.cs index bb286df251..420cc06312 100644 --- a/src/Vogen.SharedTypes/ValueObjectAttribute.cs +++ b/src/Vogen.SharedTypes/ValueObjectAttribute.cs @@ -1,21 +1,25 @@ // ReSharper disable UnusedParameter.Local // ReSharper disable NullableWarningSuppressionIsUsed // ReSharper disable UnusedType.Global + +// NOTE: +// the documentation for this doesn't show up in recent (November 2024) versions of Visual Studio. +// they do show up in versions of Rider for the same period, but for the generic attribute, +// the cursor has to hover near the right bracket of the attribute! Bug filed at https://youtrack.jetbrains.com/issue/RIDER-119448/Rider-does-not-show-XML-comments-for-generic-attributes + namespace Vogen { using System; // Generic attributes were introduced in C# 11 - /// - /// Marks a type as a Value Object. The type should be partial so that the - /// source generator can augment the type with equality and validation. - /// + /// [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct, AllowMultiple = false)] public class ValueObjectAttribute : ValueObjectAttribute { // keep this signature in-line with `VogenConfiguration` // as the syntax/semantics are read in the generator // using parameter indexes (i.e. it expected param 0 to be the underlying type etc. + /// /// Configures aspects of this individual value object. /// @@ -31,7 +35,8 @@ public class ValueObjectAttribute : ValueObjectAttribute /// See for more information. /// Controls how cast operators are generated for casting from the primitive to the Value Object. /// Options are implicit or explicit or none. Explicit is preferred over implicit if you really need them, but isn't recommended. - /// See <see href="https://github.com/SteveDunn/Vogen/wiki/Casting"/> for more information. + /// See for more information. + /// /// Specifies what is generated for IParsable types for strings - defaults to . /// Specifies what is generated for Parse and TryParse methods - defaults to . /// Specifies what to write for TryFrom methods—defaults to . @@ -83,7 +88,7 @@ public ValueObjectAttribute( } /// - /// MMMarks a type as a Value Object. The type that this is applied to should be partial so that the + /// Marks a type as a Value Object. The type that this is applied to should be partial so that the /// source generator can augment it with equality, creation barriers, and any conversions. /// [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct, AllowMultiple = false)] @@ -92,7 +97,9 @@ public class ValueObjectAttribute : Attribute // keep this signature in-line with `VogenConfiguration` // as the syntax/semantics are read in the generator // using parameter indexes (i.e. it expected param 0 to be the underlying type etc). + // ReSharper disable once MemberCanBeProtected.Global + /// /// Configures aspects of this individual value object. /// diff --git a/tests/Testbench/Folder.DotSettings b/tests/Testbench/Folder.DotSettings index 1a4d780f03..4bab2916a7 100644 --- a/tests/Testbench/Folder.DotSettings +++ b/tests/Testbench/Folder.DotSettings @@ -1,4 +1,5 @@  DO_NOT_SHOW DO_NOT_SHOW - True \ No newline at end of file + True + True \ No newline at end of file