microsoft / microsoft/win32metadata

Constants and enums should provide xml documentation

Open
#1,761 5 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
C++
Stars
1.5k
Forks
149
Avg merge
5d 16h
Merged PRs (30d)
4

Description

**Is your feature request related to a problem? Please describe.**
More than a problem is an annoyance. I noticed that constants and enums does not provide any xml documentation and this forces me to manually write them. An example is `OBJECT_IDENTIFIER` enum and `EVENT_SYSTEM_FOREGROUND` constant.

**Describe the solution you'd like**
Generate xml documentation for this types. Being forced to open the browser to see what a particular value does is not convenient.

**Describe alternatives you've considered**
Showing the whole [table](https://learn.microsoft.com/en-us/windows/win32/winauto/object-identifiers) from the Microsoft web site would be perfectly acceptable rather than mapping each value to its own description.

Contributor guide

Open the contributing guide

Research direction

Start by locating the metadata generation path for the OBJECT_IDENTIFIER enum and EVENT_SYSTEM_FOREGROUND constant. Compare the generated output with the linked Microsoft object-identifiers table; the work is done when constants and enums expose useful XML documentation without requiring separate browser research.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.