microsoft / microsoft/CsWinRT

Feature: Investigate generating intellisense xml files and/or metadata documentation

Open
#232 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement tooling
Dominant language
C#
Stars
665
Forks
134
Avg merge
1d 3h
Merged PRs (30d)
32

Description

Mano: Winmds might have intellisense associated with them which would have been a xml file per winmd containing the documentation for each type in the winmd. In order for these intellisense to be picked up, it seems a XML with the same name as the DLL needs to exist with the content of each XML file for the included winmds stitched together into one XML file.

Also consider carrying documentation (code comments) from the winmd into the generated cs files.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the WinMD-to-generated C# pipeline and identifying how generated DLL names relate to included WinMDs. Investigate whether per-WinMD XML can be combined into matching DLL-level XML, and whether WinMD code comments can be carried into generated C# files. Done means a documented, agreed approach for both capabilities.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.