microsoft / win32metadata

Tooling to generate metadata for Win32 APIs in the Windows SDK.
Other
1.32k stars 113 forks source link

Generate xmldoc descriptions for enum values #1923

Open xPaw opened 2 months ago

xPaw commented 2 months ago

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

AArnott commented 2 months ago

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.