elodin-sys
Added doc-comments to Nox
Following the discussion in issue 11 and the preliminary test in PR 12, here is a PR adding doc comments to the entire Nox codebase. As previously stated, the comments are AI-generated, with the goal of speeding up the documentation of the library (it is easier to improve a bad comment than to write one from scratch).
The PR is best examined by generating the documentation (cargo doc --open --no-deps --all-features).
Do not hesitate to comment and criticize; some comments will definitely require manual improvements.
One thing that is still missing, and should probably be done by hand, is a lib.rs top comment that serves as a documentation readme (ideally with a small code example[^example] showcasing usage and/or a link to the relevant section of the Elodin doc). You can find an example of one such comment here (rendered there).
[^example]: Overall, code examples are the big thing still missing from a new user's perspective.
