Document all public types

[Hellzbellz123]

Kinda opinionated, I feel.
Also, a generic crate level README.

I'm a pretty big fan of these Clippy lints:
“missing-docs”,
// less useful for plugins/libraries
// not enabled for this PR
“clippy::missing_docs_in_private_items”

Not intended to be merged just yet, if at all. This is probably the one that's going to need the most refinement.

[Hellzbellz123]

google is helpful :/

is there is a way to disable doc test for examples?
honestly i dont know if the example at the top is worth the effort.

also sorta feel the same way about documenting everything but it really does come down too "feel"

[johanhelsing]

“missing-docs”,

Yeah, agree this would be ideal.

[johanhelsing]

I'm not really sure what this component is for anymore. Can we remove it? In any case, "marker" components are generally unit structs (without fields).

[Hellzbellz123]

It can definitely be removed.
I only called it a marker component because of how it appeared to be used.

i did not want too add or remove types/fn with this commit, but if that is acceptable i can remove it

[johanhelsing]

Agree it's good that this is a pure doc pr

[johanhelsing]

is there is a way to disable doc test for examples? honestly i dont know if the example at the top is worth the effort.

There is

```ignore

But I don't think we should use it unless we absolutely have to. I think tested or at least compiled doc comments are great.

[Hellzbellz123]

does this need too be rebased on the most recent commits?
i noticed that the gamepad.rs on this branch does not have the updated TOUCH_GAMEPAD_ID and related comment?
will git solve this on its own when merged?

pulled from commit im about too push. purposely didnt include because main has other changes

docs for TOUCH_GAMEPAD_ID shouldnt include why its u32
if this does stay, it should be a normal comment.

// HACK: chosen at random, we're betting on no collisions with gilrs gamepads
// must be less than `u32::MAX` or breaks on 32bit platforms.
/// GamepadID for faked events
const TOUCH_GAMEPAD_ID: usize = 4264937294;

[Hellzbellz123]

I think this is ready to merge.
I ran clippy::pedantic and noticed some code that didn't really match the rest of the style, so I “fixed” it.

Furthermore, I did not change the doc comment for TOUCH_GAMEPAD_ID, but I did back-tick the const being used

[johanhelsing]

Looks good. Thanks for all the PRs :)

[johanhelsing]

docs for TOUCH_GAMEPAD_ID shouldnt include why its u32
if this does stay, it should be a normal comment.

Since this is internal API (not pub), I think it's good to have it as a doc comment.