Convert comments to doc comments where sensible #36
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Using doc comments has a couple of advantages:
Rustdoc works best with this format:
Because it will then only show the summary in some places, but I haven't changed all comments to this format and left a lot as is.
I also tried adding backticks and brackets for inline code and links, but I've undoubtedly missed a few places.
In the current version, rustdoc will generate a few warnings because I link to a few private items from public items. I'd have to know more about the internals to fix this properly and the documentation still works.
All documentation can be viewed with