docs: changes doc comments to rustdoc comments

[kbknapp]

This changes the doc comments to real rustdoc comments....mistake of mine earlier 😜

[yo-bot]

r? @Vinatorul

(yo-bot has picked a reviewer for you, use r? to override)

[sru]

Why not put them on the top of the file to be safe?

[kbknapp]

Will do once I get home ;)

[kbknapp]

Actually, @sru can you make that commit to this branch and merge? It might be some time before I get to a computer

[sru]

Done, but I am not sure about those "see documentation" and referencing to itself. I'd assume that if a person sees the top level documentation, they are currently in the documentation.

[kbknapp]

The ignore and full URL links have to go in the crate docs because rustdoc doesn't handle them too well (and the direct file links don't exist in the docs branch).

[kbknapp]

Closing this in favor of #304

I'm not sure how to revert a commit that's been pushed, I've only done it locally 😜

[sru]

@kbknapp I am not sure what you mean. I just made the link reference at the bottom (not file links), so that the text doesn't get cluttered much. And I don't know what ignore does to the code snippet.

[kbknapp]

Aaah, my mistake! I thought you changed it back to file links like in the original readme. Moving them to the bottom is a good idea 👍

The ignore tells rustdoc not to try and compile or run the snippets. Rust snippets can be marked as no_run which tells rustdoc to compile (and ensure the syntax is correct), but not run attempt to run them.