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

Generate xmldoc descriptions for enum values #1923

Open
xPaw opened this issue Jun 12, 2024 · 1 comment
Open

Generate xmldoc descriptions for enum values #1923

xPaw opened this issue Jun 12, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@xPaw
Copy link

xPaw commented Jun 12, 2024

For example, SHChangeNotify adds SHCNE_ID and SHCNF_FLAGS enums, but neither the enum itself or the values have any xmldocs.

I don't know if the metadata for these exists, but it's documented at least: https://learn.microsoft.com/en-us/windows/win32/api/shlobj_core/nf-shlobj_core-shchangenotify

@xPaw xPaw added the enhancement New feature or request label Jun 12, 2024
@AArnott
Copy link
Member

AArnott commented Jun 12, 2024

The challenge here is that there is no machine-parseable, consistently formated place to get these docs. Each enum's values may or may not be individually documented, and often the docs are scattered across docs.microsoft.com. I don't think we have xml docs for any enum values.
Any improvement we can make in this area will be in the win32metadata repo, where the docs get scraped. I'll move the issue. But ... don't hold your breath as I don't think we'll be able to fix this. docs.microsoft.com continues to be your source for some docs.

@AArnott AArnott transferred this issue from microsoft/CsWin32 Jun 12, 2024
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