Repository navigation
fix(annotations): format generic arguments with curly braces in doc cref - #2592
Open
reginaldalfret wants to merge 1 commit into
Open
reginaldalfret wants to merge 1 commit into
reginaldalfret wants to merge 1 commit into
Conversation
Signed-off-by: reginaldalfret <reginaldalfret@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
In
Amazon.Lambda.Annotations.SourceGenerator, XML documentation comments generated on the Lambda function handler class and method use<see cref="..."referencing the containing type and method signature with parameter types.When a parameter type or containing type is generic (e.g.
IEnumerable<string>,IList<IList<int>>,SqsBatchProcessor<Payload, Handler>), the type name was previously emitted with angle brackets<and>into the XML attributecref="...". This produces unescaped XML inside an attribute value, leading to CS1570, CS1584, and CS1658 compiler warnings whenever consuming projects have<GenerateDocumentationFile>true</GenerateDocumentationFile>enabled.In C# XML documentation comments, generic type arguments in
crefattributes must use curly braces{...}(e.g.IEnumerable{string}).Changes
LambdaFunctionTemplateCode.cs, addedFormatCrefType(string typeName)which replaces<and>with{and}for types formatted increfattributes.{}increfcomments.Fixes #2587