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

Rustdoc-equivalent solution for other languages #781

Open
ok300 opened this issue Feb 8, 2024 · 2 comments
Open

Rustdoc-equivalent solution for other languages #781

ok300 opened this issue Feb 8, 2024 · 2 comments

Comments

@ok300
Copy link
Contributor

ok300 commented Feb 8, 2024

The SDK has API and data model documentation in the form of rustdocs.

We need a way to provide similar docs for the other languages we support.

@ok300
Copy link
Contributor Author

ok300 commented Feb 8, 2024

A few comments from @dangeross :

It would have to be from comments in the UDL file. There are docstring’s officially in uniffi 0.25.0, which I think parse the comments from the UDL file which can then be used in the generator. I believe it was implemented by NordSecurity (they created the Go / C# bindgen’s) originally in a fork of uniffi-rs for 0.23.0

So we could potentially use their fork
https://github.com/NordSecurity/uniffi-rs/tree/main?tab=readme-ov-file#ad-hoc-features

@erdemyerebasmaz
Copy link
Contributor

We can use dartdoc for Flutter plugin. It's usable out of the box but we'll need to tinker around with it's configuration to exclude most of generated rust bridge elements(wire2api, api2wire sections etc.) as they are gibberish to API users.

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

No branches or pull requests

2 participants