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

byondapi-sys improvements and ffi documentation #10

Merged
merged 1 commit into from
Dec 14, 2023
Merged

byondapi-sys improvements and ffi documentation #10

merged 1 commit into from
Dec 14, 2023

Conversation

Absolucy
Copy link
Contributor

@Absolucy Absolucy commented Dec 14, 2023 •
edited
Loading

just a few useful changes for byondapi-sys

  • use slightly more vague version definitions, to prevent annoyances with multiple different versions being locked
  • generate rustdocs for the bindings from the byondapi header's doxygen comments
  • don't re-implement every ffi method in the public ByondApi, instead just provide a transparent Deref<Target = RawByondApi> impl
  • expose byond_rawbind::ByondApi in documentation (needed in order to properly see the docs through the deref)

Generated rustdoc example

2023-12-14 (1702586007) ~ ByondApi_in_byondapi_sys_-Rust—_Mozilla_Firefox

jupyterkat
jupyterkat requested changes Dec 14, 2023
View reviewed changes
crates/byondapi-sys/build.rs Outdated Show resolved Hide resolved
@jupyterkat jupyterkat merged commit c4e2876 into spacestation13:main Dec 14, 2023
@Absolucy Absolucy deleted the sysdocs branch December 14, 2023 22:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jupyterkat jupyterkat jupyterkat approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Absolucy @jupyterkat