Add generated XML docs to __ObservableValidatorExtensions

CommunityToolkit · Mar 25, 2023 · 1ca30ff · 1ca30ff
1 parent 873c1c3
commit 1ca30ff
Showing 1 changed file with 23 additions and 3 deletions.
diff --git a/...rceGenerators/ComponentModel/ObservableValidatorValidateAllPropertiesGenerator.Execute.cs b/...rceGenerators/ComponentModel/ObservableValidatorValidateAllPropertiesGenerator.Execute.cs
@@ -96,6 +96,9 @@ public static CompilationUnitSyntax GetSyntax(bool isDynamicallyAccessedMembersA
 
             // Prepare the base attributes with are always present:
             //
+            // /// <summary>
+            // /// A helper type with generated validation stubs for types deriving from <see cref="global::CommunityToolkit.Mvvm.ComponentModel.ObservableValidator"/>.
+            // /// </summary>
             // [global::System.CodeDom.Compiler.GeneratedCode("...", "...")]
             // [global::System.Diagnostics.DebuggerNonUserCode]
             // [global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
@@ -105,7 +108,11 @@ public static CompilationUnitSyntax GetSyntax(bool isDynamicallyAccessedMembersA
                 AttributeList(SingletonSeparatedList(
                     Attribute(IdentifierName($"global::System.CodeDom.Compiler.GeneratedCode")).AddArgumentListArguments(
                         AttributeArgument(LiteralExpression(SyntaxKind.StringLiteralExpression, Literal(typeof(ObservableValidatorValidateAllPropertiesGenerator).FullName))),
-                        AttributeArgument(LiteralExpression(SyntaxKind.StringLiteralExpression, Literal(typeof(ObservableValidatorValidateAllPropertiesGenerator).Assembly.GetName().Version.ToString())))))));
+                        AttributeArgument(LiteralExpression(SyntaxKind.StringLiteralExpression, Literal(typeof(ObservableValidatorValidateAllPropertiesGenerator).Assembly.GetName().Version.ToString()))))))
+                .WithOpenBracketToken(Token(TriviaList(
+                    Comment("/// <summary>"),
+                    Comment("/// A helper type with generated validation stubs for types deriving from <see cref=\"global::CommunityToolkit.Mvvm.ComponentModel.ObservableValidator\"/>."),
+                    Comment("/// </summary>")), SyntaxKind.OpenBracketToken, TriviaList())));
             attributes.Add(AttributeList(SingletonSeparatedList(Attribute(IdentifierName("global::System.Diagnostics.DebuggerNonUserCode")))));
             attributes.Add(AttributeList(SingletonSeparatedList(Attribute(IdentifierName("global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage")))));
             attributes.Add(
@@ -176,8 +183,14 @@ public static CompilationUnitSyntax GetSyntax(ValidationInfo validationInfo)
             // #pragma warning disable
             // namespace CommunityToolkit.Mvvm.ComponentModel.__Internals
             // {
+            //     /// <inheritdoc/>
             //     partial class __ObservableValidatorExtensions
             //     {
+            //         /// <summary>
+            //         /// Creates a validation stub for <see cref="<INSTANCE_TYPE>"/> objects.
+            //         /// </summary>
+            //         /// <param name="_">Dummy parameter, only used to disambiguate the method signature.</param>
+            //         /// <returns>A validation stub for <see cref="<INSTANCE_TYPE>"/> objects.</returns>
             //         [global::System.ComponentModel.EditorBrowsable(global::System.ComponentModel.EditorBrowsableState.Never)]
             //         [global::System.Obsolete("This method is not intended to be called directly by user code")]
             //         public static global::System.Action<object> CreateAllPropertiesValidator(<INSTANCE_TYPE> _)
@@ -197,13 +210,20 @@ public static CompilationUnitSyntax GetSyntax(ValidationInfo validationInfo)
                 NamespaceDeclaration(IdentifierName("CommunityToolkit.Mvvm.ComponentModel.__Internals")).WithLeadingTrivia(TriviaList(
                     Comment("// <auto-generated/>"),
                     Trivia(PragmaWarningDirectiveTrivia(Token(SyntaxKind.DisableKeyword), true)))).AddMembers(
-                ClassDeclaration("__ObservableValidatorExtensions").AddModifiers(Token(SyntaxKind.PartialKeyword)).AddMembers(
+                ClassDeclaration("__ObservableValidatorExtensions").AddModifiers(
+                    Token(TriviaList(Comment("/// <inheritdoc/>")), SyntaxKind.PartialKeyword, TriviaList())).AddMembers(
                 MethodDeclaration(
                     GenericName("global::System.Action").AddTypeArgumentListArguments(PredefinedType(Token(SyntaxKind.ObjectKeyword))),
                     Identifier("CreateAllPropertiesValidator")).AddAttributeLists(
                         AttributeList(SingletonSeparatedList(
                             Attribute(IdentifierName("global::System.ComponentModel.EditorBrowsable")).AddArgumentListArguments(
-                            AttributeArgument(ParseExpression("global::System.ComponentModel.EditorBrowsableState.Never"))))),
+                            AttributeArgument(ParseExpression("global::System.ComponentModel.EditorBrowsableState.Never")))))
+                        .WithOpenBracketToken(Token(TriviaList(
+                            Comment("/// <summary>"),
+                            Comment($"/// Creates a validation stub for <see cref=\"{validationInfo.TypeName}\"/> objects."),
+                            Comment("/// </summary>"),
+                            Comment("/// <param name=\"_\">Dummy parameter, only used to disambiguate the method signature.</param>"),
+                            Comment($"/// <returns>A validation stub for <see cref=\"{validationInfo.TypeName}\"/> objects.</returns>")), SyntaxKind.OpenBracketToken, TriviaList())),
                         AttributeList(SingletonSeparatedList(
                             Attribute(IdentifierName("global::System.Obsolete")).AddArgumentListArguments(
                             AttributeArgument(LiteralExpression(