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

NamespaceDoc support #127

Open
eli-darkly opened this issue Jan 29, 2021 · 1 comment
Open

NamespaceDoc support #127

eli-darkly opened this issue Jan 29, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@eli-darkly
Copy link

eli-darkly commented Jan 29, 2021

.NET itself doesn't (as far as I know) have a standard for attaching a documentation comment to a whole namespace, but for a long time the Sandcastle HTML documentation generator has supported doing this by declaring an internal-scoped class called NamespaceDoc in that namespace and putting the doc comment on that. FuGet doesn't seem to put any special significance on NamespaceDoc, but also, it doesn't seem to even parse the docs for that class correctly as a class: if you click on NamespaceDoc, it shows the <summary> text but not the <remarks>. This means developers may be missing quite a bit of documentation that the library maintainer wrote at the namespace level.

@praeclarum
Copy link
Owner

Yeah I didn't realize how important the remarks were. I will look into adding them in.

I'm a little confused about the NamespaceDoc. Can you point me to a URL?

@praeclarum praeclarum added the enhancement New feature or request label Feb 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants