microsoft / microsoft/WindowsAppSDK
Ship XML doc files alongside .winmd in Microsoft.WindowsAppSDK.AI NuGet package
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 4.7k
- Forks
- 471
- Avg merge
- 3d 13h
- Merged PRs (30d)
- 28
Description
The Microsoft.WindowsAppSDK.AI NuGet package currently ships .winmd metadata files but does not include the corresponding .xml documentation files (C# XML doc format).
Other WinAppSDK sub-packages already ship .xml alongside .winmd:
| Package | XML Docs Included |
|---|---|
| Microsoft.WindowsAppSDK.Foundation | Partial |
| Microsoft.WindowsAppSDK.WinUI | Yes |
| Microsoft.WindowsAppSDK.Widgets | Yes |
| Microsoft.WindowsAppSDK.AI | No |
| Microsoft.WindowsAppSDK.ML | No |
| Microsoft.WindowsAppSDK.Search | No |
For comparison, other WinAppSDK packages already include XML documentation files alongside .winmd.
Microsoft.WindowsAppSDK.Foundation includes both .winmd and .xml files:
In contrast, Microsoft.WindowsAppSDK.AI currently only includes .winmd files, with no corresponding .xml documentation:
Impact
Poor IntelliSense experience in Visual Studio and VS Code
Without .xml files, API descriptions are missing or minimal in IntelliSense, making it harder for developers to understand and use the APIs effectively.
Without .xml files, generated bindings lack API documentation:
With .xml documentation present, generated bindings include rich descriptions:
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing how Microsoft.WindowsAppSDK.Foundation, Microsoft.WindowsAppSDK.WinUI, and Microsoft.WindowsAppSDK.Widgets package their .winmd and .xml files, then trace the packaging configuration for Microsoft.WindowsAppSDK.AI. Done means the AI NuGet package ships corresponding C# XML documentation files alongside its .winmd metadata so IntelliSense exposes API descriptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- build-system, release
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100