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

[Feature Request] Add support for note doc comment tags that is defined at root element. #10377

Open
filzrev opened this issue Nov 9, 2024 · 0 comments

Comments

@filzrev
Copy link
Contributor

filzrev commented Nov 9, 2024

Is your feature request related to a problem? Please describe.

note doc comment tag is User-defined tags that is used by SandCastle.
And note tag seems to be supported by docfx by default. (https://github.com/dotnet/docfx/blob/efc1c3df765a3514f2bc5c786e5d05c003a466fd/src/Docfx.Dotnet/Resources/XmlCommentTransform.xsl#L68-L94)

But it's not works when <note> tags are defined as root element.
If it's defined inside of <summary> or <remarks> element. It works as expected.

Describe the solution you'd like

  1. Add Notes property to XmlComment.cs class.
  2. Store XSL transformed notes to Notes property.
  3. Render notes HTML if exists.
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

No branches or pull requests

1 participant