Add a automated documentation generator, similar to `javadoc`
Closed this issue · 1 comments
Summary
javadoc
makes it so that we can automatically generate documentation of Java code. I think this would be helpful for us to implement so that we don't have to manually generate documentation ourselves.
I'm currently exploring lazydocs
in combination with autoDocstring.
Reasoning
The current structure makes it so that we'd have to manually add the documentation ourselves, which adds extra labor. Having a javadoc
-like tool in the repository makes it so that we can just focus on the code rather than the documentation.
This doesn't mean we won't focus on documentation, and the docs generated by the tool would not be the finalized version. We'd polish them up to make it feel more humane.
Rust comes included with that. Use cargo doc
to create the docs.rs-like website. I don't know if I like this, but something is something.
It turns out that Rust isn't consistent when it comes to documentation, so we can't accurately document the parameters. We'd have to make our own style.