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.

Sign up for GitHub

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

Jump to bottom

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
@halildurmus
Labels
automation Replace handcrafted code that doesn't scale documentation Improvements or additions to documentation feature A new feature or request P2 Medium-priority issue package: generator Issue with package:generator
Milestone
win32 v6

Comments

@halildurmus
Copy link
Owner

halildurmus commented Feb 25, 2024 •
edited
Loading

Currently, the documentation for the generated APIs is hand-crafted. With #819, automating this process and generating documentation directly is necessary.

Microsoft provides a convenient solution through the Microsoft.Windows.SDK.Win32Docs package on NuGet. This package includes a MessagePack dictionary that maps API names to ApiDetails objects, containing all the necessary documentation.

By using this resource, the generator can create documentation for a wide range of API elements:

  • Win32 callbacks
  • Win32 constants
  • Win32 enumerations
  • Win32 functions
  • Win32 structures
  • COM interfaces
@halildurmus halildurmus added documentation Improvements or additions to documentation feature A 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 package: generator Issue with package:generator label Feb 25, 2024
@halildurmus halildurmus added the P2 Medium-priority issue label Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@halildurmus halildurmus

Labels
automation Replace handcrafted code that doesn't scale documentation Improvements or additions to documentation feature A new feature or request P2 Medium-priority issue package: generator Issue with package:generator
Projects
None yet
Milestone
win32 v6
Development

No branches or pull requests
1 participant
@halildurmus