Add DocumentationRemarks to the DocumentationMember #291
Conversation
This file contains 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
… the <remarks /> section from the XmlDoc. Include tests which also document the need for a <summary /> or <inheritdoc /> section to access it via GetDocumentationMember(). This is mainly to keep backward compatibility with the currently emitted code. reinforced#290
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.
This PR adds the
DocumentationRemarkstype which stores the content from XmlDocs<remarks />section.The behaviour of the emitted code is not changed:
DocumentationMember.GetDocumentationMemberwill returnnullif a member has only a ´` section but no other XmlDoc related data<remarks />section is just stored in theDocumentationMemberbut not used in any provided code generator implementation.However, when writing a custom code generator, the content of the
<remarks />section is now available.This fixes #290.