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.

Sign up for GitHub

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

Jump to bottom

XML documentation #451

Open
adambajguz opened this issue Jan 11, 2023 · 2 comments
Open

XML documentation #451

adambajguz opened this issue Jan 11, 2023 · 2 comments
Labels
documentation Documentation change enhancement New feature or request help wanted Extra attention is needed

Comments

@adambajguz
Copy link

Proposal:
Add XML documentation to all types, methods, etc.

Current behavior:
No XML documentation in the libraries.

Desired behavior:
All APIs, classes, etc. should be annotated with XML documentation comments.
@adambajguz
Copy link
Author

I've just discoverd that in the source code the XML documenation is present but in the NuGet it is not.
image

This may be due to missing <GenerateDocumentationFile>true</GenerateDocumentationFile>

@powersj
Copy link
Contributor

powersj commented Jan 25, 2023

This may be due to missing true

Happy to see a PR with this change!

@powersj powersj added enhancement New feature or request documentation Documentation change help wanted Extra attention is needed labels Jan 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Documentation change enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@powersj @adambajguz