Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include the <remarks /> from the XmlDoc into the DocumentationMember #290

Open
smkanadl opened this issue Jan 12, 2025 · 0 comments · May be fixed by #291
Open

Include the <remarks /> from the XmlDoc into the DocumentationMember #290

smkanadl opened this issue Jan 12, 2025 · 0 comments · May be fixed by #291

Comments

@smkanadl
Copy link
Contributor

In the current state the DocumentationMember does not have a property for hence they are not parsed from the file.

This makes sense as there is no direct equivalent in JSDoc. However, when writing custom code generators one might want to include the remarks into the default description etc.

I would suggest to add this to the DocumentationMember class.

        [XmlElement(ElementName = "remarks")]
        public DocumentationRemarks Remarks { get; set; }
smkanadl added a commit to smkanadl/Reinforced.Typings that referenced this issue Jan 12, 2025
… 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
@smkanadl smkanadl linked a pull request Jan 12, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant