Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate documentation for APIs #823

Open
halildurmus opened this issue Feb 25, 2024 · 0 comments
Open

Generate documentation for APIs #823

halildurmus opened this issue Feb 25, 2024 · 0 comments
Assignees
Labels
automation Replace handcrafted code that doesn't scale documentation Improvements to documentation / samples enhancement New feature or request generator Issue with package:generator
Milestone

Comments

@halildurmus
Copy link
Member

With #819, there is a need to find a way to generate documentation for APIs.

Fortunately, Microsoft offers a convenient solution through the Microsoft.Windows.SDK.Win32Docs package, available on NuGet. This package includes a MessagePack dictionary, where API names function as keys and ApiDetails objects as values, providing an extensive range of documentation resources.

By leveraging this dictionary, the generator can produce documentation covering a wide range of elements, including:

  • Win32 callbacks
  • Win32 constants
  • Win32 enumerations and their fields
  • Win32 functions
  • Win32 structures and their fields
  • COM interfaces and their methods
@halildurmus halildurmus added documentation Improvements to documentation / samples enhancement New feature or request automation Replace handcrafted code that doesn't scale labels Feb 25, 2024
@halildurmus halildurmus added this to the 6.0.0 milestone Feb 25, 2024
@halildurmus halildurmus self-assigned this Feb 25, 2024
@halildurmus halildurmus added the generator Issue with package:generator label Feb 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation Replace handcrafted code that doesn't scale documentation Improvements to documentation / samples enhancement New feature or request generator Issue with package:generator
Projects
None yet
Development

No branches or pull requests

1 participant