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

feat: add generated binding documentation #29

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

ianprime0509
Copy link
Owner

@ianprime0509 ianprime0509 commented Jan 28, 2024

Closes #13

TODO:

  • Autodoc doesn't handle module names containing . properly (probably solve this when implementing URL escaping) (WIP: https://github.com/ianprime0509/zig/tree/autodoc-url-escape)
  • Autodoc displays aliased functions using the aliasee name (e.g. gtk_box_new), not the alias name (e.g. new)
  • Handling docs through a compilation step with -femit-docs has unintended consequences, it tries to look up system libraries to link via pkg-config even though nothing needs to be linked
  • Root module page is ugly

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate documentation using Autodoc
1 participant