Add rustdoc comments to all public APIs

[DonIsaac]

Good documentation is a critical part of promoting adoption from other projects. If users cannot understand how to use our tools, odds are they wont. We should document as much of our public API as possible. At the very least, all mostly-stable APIs should have examples and descriptions on how to use them.

We have a lot of great examples, but many options and return structures are missing descriptions. Plenty of business logic is also missing descriptions.

Crates

These are, in my opinion, the crates that are most important to document right now

• oxc (doesn't receive module docs from its re-exports, README is missing)
• oxc_parser (mostly documented)
• oxc_ast (partially documented)
• oxc_transformer
• oxc_codegen
• oxc_isolated_declarations
• oxc_semantic
• oxc_span
• docs(diagnostics): fully document oxc_diagnostics oxc#5865

Basically, if it's used anywhere from reading a file -> parsing -> transforming -> printing, then it is a high-priority candidate.

[overlookmotel]

Just to add, documentation on internal APIs is also helpful - not just for new contributors, but also for the core team. I often find myself a bit lost in areas of codebase I've not been in for a while. Obviously, public API is higher priority, though.

[overlookmotel]

I don't know why this won't transfer to backlog repo cleanly. Github seems to have some kinks.

But the main points of original issue are here. Original issue was oxc-project/oxc#5870