-
Notifications
You must be signed in to change notification settings - Fork 113
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
Constants and enums should provide xml documentation #1761
Comments
Not all constants have documented summaries. (And I think all enums are constants to win32). I'd love to get docs more thoroughly applied to constants, but it can be tricky because the docs' representation of summaries for them varies a lot (far more than it varies for functions), and we get the docs by scraping the docs web site (or rather, the repo behind it). |
I understand what you mean. Pheraps, when the format/layout of the documentation is not supported by the scraper, an option could be to allow the user to upload the snippets with the required documentation in some section of the repo. This means that it will not be an automated process anymore and new constants will lack docs unless someone upload the updates. However, a couple of new constants without documentation is still better than no documentation at all. |
Are you saying that you want xml docs on the generated APIs enough that you'd be willing to fetch them from the online documentation and check them into your repo manually? If so, we may be able to add such support for that in CsWin32. |
Well, I means more something like pull requests doable directly from within VS in order to open the feature to all the users, not only the ones with a cloned CsWin32 repo. Something like this showing in intellisense:
Not sure on how could be implemented the UI interaction side. Would be very easy with a VSIX extension, but without I have no idea (may be a source generator or some script in NuGet?). Given that CsWin32 is part of Microsoft, the best would be a little change to the Ide that, based on the presence of a CsWin32 package, will automatically take care of the submission. |
That sounds great, but it's not going to happen. |
Is your feature request related to a problem? Please describe.
More than a problem is an annoyance. I noticed that constants and enums does not provide any xml documentation and this forces me to manually write them. An example is
OBJECT_IDENTIFIER
enum andEVENT_SYSTEM_FOREGROUND
constant.Describe the solution you'd like
Generate xml documentation for this types. Being forced to open the browser to see what a particular value does is not convenient.
Describe alternatives you've considered
Showing the whole table from the Microsoft web site would be perfectly acceptable rather than mapping each value to its own description.
The text was updated successfully, but these errors were encountered: