search

rust-diplomat / diplomat

Experimental Rust tool for generating FFI definitions allowing many other languages to call Rust code
https://rust-diplomat.github.io/book/
Other
499 stars 47 forks source link

Add docs to C, C++, JS #630

Open robertbastian opened 1 month ago

robertbastian commented 1 month ago

These three HIR backends do not currently produce docs. See the Dart backend for an example.

YJDoc2 commented 3 weeks ago

Hey, is this issue related to adding the doc comments, or the doc comments not actually producing rust docs? I was looking in https://github.com/rust-diplomat/diplomat/tree/main/tool/src/c , and https://github.com/rust-diplomat/diplomat/tree/main/tool/src/js , the source files seem to have doc comments. Is there any other kind of documentation to be added, or am I looking in wrong places?

Manishearth commented 3 weeks ago

This issue is about adding some form of documentation (comments, sphinx, something) to the code generated by these backends.

This isn't about rustdoc.