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

XML documentation is not included in the package #1258

Closed
hainguyenthanh opened this issue Nov 24, 2020 · 3 comments · Fixed by #1386
Closed

XML documentation is not included in the package #1258

hainguyenthanh opened this issue Nov 24, 2020 · 3 comments · Fixed by #1386
Assignees
Milestone

Comments

@hainguyenthanh
Copy link

Steps to reproduce

Add a reference to the package to a project in an IDE that supports viewing XML documentation, for example, Visual Studio. Use any types of methods provided by the package.

The issue

No XML documentation is available when using this package. This issue costs developers a lot of time trying to figure out how to use the package's public APIs.

Please include the XML documentation files together with the assemblies in the package.

@lauxjpn lauxjpn self-assigned this Nov 25, 2020
@lauxjpn
Copy link
Collaborator

lauxjpn commented Nov 25, 2020

@hainguyenthanh Looks fine when I try it:

Visual Studio 2019, 16.8.2

image

Rider 2020.3 EAP 8

image

Also, the package itself does contain the necessary XML docs file:

image

So to find out where the issue is, we have to investigate a bit further:

  • For what method do you expect there to be XML documentation available?
  • What IDE are you using?

It might also be helpful, if you can share your project/solution with us.

@hainguyenthanh
Copy link
Author

@lauxjpn I'm using the stable version 3.2.4 and it seems that the XML documentation is not included in this version. The 5.0.0 alpha 2 version does include documentation.

@lauxjpn
Copy link
Collaborator

lauxjpn commented Nov 25, 2020

@hainguyenthanh Ah, that is correct, we included the XML docs in the major 5.0 upgrade.
I'll add the docs to the 3.2-maint branch as well.

@lauxjpn lauxjpn added this to the 3.2.5 milestone Apr 21, 2021
@lauxjpn lauxjpn linked a pull request Apr 21, 2021 that will close this issue
@lauxjpn lauxjpn closed this as completed Apr 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants