-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Support for namespace XML doc comments #315
Labels
Milestone
Comments
This was referenced Mar 22, 2017
Implementation proposed at dotnet/roslyn#15494 |
I'm championing this for LDM triage. |
Thanks @gafter, just let me know when/if you need anything else from my end |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Over the years, different .NET documentation generators have used different techniques for representing documentation on a namespace. For example, NDoc and SHFB both use a special
NamespaceDoc
class and "promote" any XML doc comments on that type to the containing namespace.As far as I can tell, Roslyn doesn't currently support XML doc comments on namespaces (there's no
GetDocumentationCommentXml()
override for namespace symbols). I propose that XML doc comments applied to a use of the namespace get picked up and returned fromGetDocumentationCommentXml()
. This would work just like a partial class and if multiple doc comment blocks are provided for a namespace, the last one wins.I suppose namespace comments should also be included in the generated XML documentation output file (as created in
DocumentationCommentCompiler
). That seems like it might be a bit trickier since consumers probably don't expect comment elements at the namespace level. Is there a formalized schema somewhere for this XML output?(copied from dotnet/roslyn#15474)
The text was updated successfully, but these errors were encountered: