Improve docs #64
Improve docs #64
Conversation
Right now, only basic things are changed (remove ``@`` annotations, trim spaces, etc.). In the future, changes will be made (mostly to _truly_ transform ``@param``to rustdoc conventions. Right now, the documentation is mostly decent, and definitely understandable
|
I added a simple docstring to rustdoc conversion mechanism. Now the documentation generated by bindgen is usable. Example screenshot of random function: |
| @@ -29,3 +28,5 @@ bindgen "$DEVKITPRO/libctru/include/3ds.h" \ | |||
| -DARM11 \ | |||
| -D__3DS__ \ | |||
| > src/bindings.rs | |||
|
|
|||
| cargo run --bin docstring-to-rustdoc -- src/bindings.rs | |||
There was a problem hiding this comment.
Related (fyi): rust-lang/rust-bindgen#955
There was a problem hiding this comment.
Ohh, I didn't see that until now! Thanks, I'll check it out!
There was a problem hiding this comment.
Nothing's implemented there, but someone else did have the idea to open an issue at least.
| @@ -29,3 +28,5 @@ bindgen "$DEVKITPRO/libctru/include/3ds.h" \ | |||
| -DARM11 \ | |||
| -D__3DS__ \ | |||
| > src/bindings.rs | |||
|
|
|||
| cargo run --bin docstring-to-rustdoc -- src/bindings.rs | |||
There was a problem hiding this comment.
Nothing's implemented there, but someone else did have the idea to open an issue at least.
| @@ -0,0 +1,70 @@ | |||
| //! This script transforms _some_ Boxygen comments to Rustdoc format | |||
There was a problem hiding this comment.
Nice! I had been looking for something like this builtin to bindgen but this little script is a good workaround.
There was a problem hiding this comment.
I'm working on something more advanced on a personal repo, if you are interested to check it out: Techie-Pi/doxygen-rs
Following some suggestions from #32, I've made some changes to improve documentation.
rustdocsuggestionsFs(mostly minor syntax issues)--no-doc-commentsfrombindgen.shto generate kind of docs for users ofctru-sys