Skip to content

Ship XML doc files alongside .winmd in Microsoft.WindowsAppSDK.AI NuGet package #6423

@lei9444

Description

@lei9444

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:
Image

In contrast, Microsoft.WindowsAppSDK.AI currently only includes .winmd files, with no corresponding .xml documentation:
Image

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:
Image

With .xml documentation present, generated bindings include rich descriptions:
Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    area-WCRWindows App SDK integration with Windows AI APIs for OCR, image & text analysis etc.documentationImprovements or additions to documentationneeds-triage

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions