Generate documentation comment for GetWrappedType

sharwell · sharwell · commit 510d9492468b · 2020-12-01T18:14:09.000-08:00
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.CodeGeneration/OperationLightupGenerator.cs b/StyleCop.Analyzers/StyleCop.Analyzers.CodeGeneration/OperationLightupGenerator.cs
@@ -684,6 +684,11 @@ private void GenerateOperationWrapperHelper(in GeneratorExecutionContext context
                 body: SyntaxFactory.Block(staticCtorStatements),
                 expressionBody: null);
 
+            // /// <summary>
+            // /// Gets the type that is wrapped by the given wrapper.
+            // /// </summary>
+            // /// <param name="wrapperType">Type of the wrapper for which the wrapped type should be retrieved.</param>
+            // /// <returns>The wrapped type, or null if there is no info.</returns>
             // internal static Type GetWrappedType(Type wrapperType)
             // {
             //     if (WrappedTypes.TryGetValue(wrapperType, out Type wrappedType))
@@ -730,6 +735,25 @@ private void GenerateOperationWrapperHelper(in GeneratorExecutionContext context
                     SyntaxFactory.ReturnStatement(SyntaxFactory.LiteralExpression(SyntaxKind.NullLiteralExpression))),
                 expressionBody: null);
 
+            getWrappedType = getWrappedType.WithLeadingTrivia(SyntaxFactory.TriviaList(
+                SyntaxFactory.Trivia(SyntaxFactory.DocumentationComment(
+                    SyntaxFactory.XmlText(" "),
+                    SyntaxFactory.XmlSummaryElement(
+                        SyntaxFactory.XmlNewLine(Environment.NewLine),
+                        SyntaxFactory.XmlText(" Gets the type that is wrapped by the given wrapper."),
+                        SyntaxFactory.XmlNewLine(Environment.NewLine),
+                        SyntaxFactory.XmlText(" ")),
+                    SyntaxFactory.XmlNewLine(Environment.NewLine),
+                    SyntaxFactory.XmlText(" "),
+                    SyntaxFactory.XmlParamElement(
+                        "wrapperType",
+                        SyntaxFactory.XmlText("Type of the wrapper for which the wrapped type should be retrieved.")),
+                    SyntaxFactory.XmlNewLine(Environment.NewLine),
+                    SyntaxFactory.XmlText(" "),
+                    SyntaxFactory.XmlReturnsElement(
+                        SyntaxFactory.XmlText("The wrapped type, or null if there is no info.")),
+                    SyntaxFactory.XmlNewLine(Environment.NewLine).WithoutTrailingTrivia()))));
+
             var wrapperHelperClass = SyntaxFactory.ClassDeclaration(
                 attributeLists: default,
                 modifiers: SyntaxTokenList.Create(SyntaxFactory.Token(SyntaxKind.InternalKeyword)).Add(SyntaxFactory.Token(SyntaxKind.StaticKeyword)),
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.CodeGeneration/SyntaxLightupGenerator.cs b/StyleCop.Analyzers/StyleCop.Analyzers.CodeGeneration/SyntaxLightupGenerator.cs
@@ -935,6 +935,11 @@ private void GenerateSyntaxWrapperHelper(in GeneratorExecutionContext context, I
                 body: SyntaxFactory.Block(staticCtorStatements),
                 expressionBody: null);
 
+            // /// <summary>
+            // /// Gets the type that is wrapped by the given wrapper.
+            // /// </summary>
+            // /// <param name="wrapperType">Type of the wrapper for which the wrapped type should be retrieved.</param>
+            // /// <returns>The wrapped type, or null if there is no info.</returns>
             // internal static Type GetWrappedType(Type wrapperType)
             // {
             //     if (WrappedTypes.TryGetValue(wrapperType, out Type wrappedType))
@@ -981,6 +986,25 @@ private void GenerateSyntaxWrapperHelper(in GeneratorExecutionContext context, I
                     SyntaxFactory.ReturnStatement(SyntaxFactory.LiteralExpression(SyntaxKind.NullLiteralExpression))),
                 expressionBody: null);
 
+            getWrappedType = getWrappedType.WithLeadingTrivia(SyntaxFactory.TriviaList(
+                SyntaxFactory.Trivia(SyntaxFactory.DocumentationComment(
+                    SyntaxFactory.XmlText(" "),
+                    SyntaxFactory.XmlSummaryElement(
+                        SyntaxFactory.XmlNewLine(Environment.NewLine),
+                        SyntaxFactory.XmlText(" Gets the type that is wrapped by the given wrapper."),
+                        SyntaxFactory.XmlNewLine(Environment.NewLine),
+                        SyntaxFactory.XmlText(" ")),
+                    SyntaxFactory.XmlNewLine(Environment.NewLine),
+                    SyntaxFactory.XmlText(" "),
+                    SyntaxFactory.XmlParamElement(
+                        "wrapperType",
+                        SyntaxFactory.XmlText("Type of the wrapper for which the wrapped type should be retrieved.")),
+                    SyntaxFactory.XmlNewLine(Environment.NewLine),
+                    SyntaxFactory.XmlText(" "),
+                    SyntaxFactory.XmlReturnsElement(
+                        SyntaxFactory.XmlText("The wrapped type, or null if there is no info.")),
+                    SyntaxFactory.XmlNewLine(Environment.NewLine).WithoutTrailingTrivia()))));
+
             var wrapperHelperClass = SyntaxFactory.ClassDeclaration(
                 attributeLists: default,
                 modifiers: SyntaxTokenList.Create(SyntaxFactory.Token(SyntaxKind.InternalKeyword)).Add(SyntaxFactory.Token(SyntaxKind.StaticKeyword)),
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/Lightup/.generated/StyleCop.Analyzers.CodeGeneration/StyleCop.Analyzers.CodeGeneration.OperationLightupGenerator/OperationWrapperHelper.g.cs b/StyleCop.Analyzers/StyleCop.Analyzers/Lightup/.generated/StyleCop.Analyzers.CodeGeneration/StyleCop.Analyzers.CodeGeneration.OperationLightupGenerator/OperationWrapperHelper.g.cs
@@ -140,6 +140,11 @@ static OperationWrapperHelper()
             WrappedTypes = builder.ToImmutable();
         }
 
+        /// <summary>
+        /// Gets the type that is wrapped by the given wrapper.
+        /// </summary>
+        /// <param name = "wrapperType">Type of the wrapper for which the wrapped type should be retrieved.</param>
+        /// <returns>The wrapped type, or null if there is no info.</returns>
         internal static Type GetWrappedType(Type wrapperType)
         {
             if (WrappedTypes.TryGetValue(wrapperType, out Type wrappedType))
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/Lightup/.generated/StyleCop.Analyzers.CodeGeneration/StyleCop.Analyzers.CodeGeneration.SyntaxLightupGenerator/SyntaxWrapperHelper.g.cs b/StyleCop.Analyzers/StyleCop.Analyzers/Lightup/.generated/StyleCop.Analyzers.CodeGeneration/StyleCop.Analyzers.CodeGeneration.SyntaxLightupGenerator/SyntaxWrapperHelper.g.cs
@@ -70,6 +70,11 @@ static SyntaxWrapperHelper()
             WrappedTypes = builder.ToImmutable();
         }
 
+        /// <summary>
+        /// Gets the type that is wrapped by the given wrapper.
+        /// </summary>
+        /// <param name = "wrapperType">Type of the wrapper for which the wrapped type should be retrieved.</param>
+        /// <returns>The wrapped type, or null if there is no info.</returns>
         internal static Type GetWrappedType(Type wrapperType)
         {
             if (WrappedTypes.TryGetValue(wrapperType, out Type wrappedType))

Original file line number	Diff line number	Diff line change
`@@ -140,6 +140,11 @@ static OperationWrapperHelper()`
`140`	`140`	`WrappedTypes = builder.ToImmutable();`
`141`	`141`	`}`
`142`	`142`
	`143`	`+ /// <summary>`
	`144`	`+ /// Gets the type that is wrapped by the given wrapper.`
	`145`	`+ /// </summary>`
	`146`	`+ /// <param name = "wrapperType">Type of the wrapper for which the wrapped type should be retrieved.</param>`
	`147`	`+ /// <returns>The wrapped type, or null if there is no info.</returns>`
`143`	`148`	`internal static Type GetWrappedType(Type wrapperType)`
`144`	`149`	`{`
`145`	`150`	`if (WrappedTypes.TryGetValue(wrapperType, out Type wrappedType))`
Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,11 @@ static SyntaxWrapperHelper()`
`70`	`70`	`WrappedTypes = builder.ToImmutable();`
`71`	`71`	`}`
`72`	`72`
	`73`	`+ /// <summary>`
	`74`	`+ /// Gets the type that is wrapped by the given wrapper.`
	`75`	`+ /// </summary>`
	`76`	`+ /// <param name = "wrapperType">Type of the wrapper for which the wrapped type should be retrieved.</param>`
	`77`	`+ /// <returns>The wrapped type, or null if there is no info.</returns>`
`73`	`78`	`internal static Type GetWrappedType(Type wrapperType)`
`74`	`79`	`{`
`75`	`80`	`if (WrappedTypes.TryGetValue(wrapperType, out Type wrappedType))`